stellar / developers Goto Github PK

https://www.stellar.org/developers/learn/concepts/transactions.html
the ##headings didn't get converted from the .md correctly

It's currently impossible to build a project, probably broken since: #88.

[12:01:41] 'build' errored after 650 ms
[12:01:41] Error: ENOENT: no such file or directory, stat '/Users/bartek/developers/src/horizon'
    at Error (native)

Looks like src/horizon symlink destination doesn't exist:

horizon -> ../repos/go/services/horizon/docs

I would fix this but I'm not sure what was a decision around horizon docs when moving it to monorepo (stellar/go#93).

listed here: stellar.org/developers
and here: https://www.stellar.org/developers/reference/
https://github.com/elucidsoft/dotnetcore-stellar-sdk

https://en.wikipedia.org/wiki/Canonical_link_element

Some pages have multiple ways of getting to. For example, root pages can be accessed via /index.html and /. The canonical link element resolves this "duplication" of content.

For example, https://www.stellar.org/developers/learn/index.html and https://www.stellar.org/developers/learn/index.html would have the following html tag:

<link rel="canonical" href="https://www.stellar.org/developers/learn/" />

This is disconcerting. It shouldn't collapse things for the user.

Globs don't ensure that the result is sorted alphabetically. Some things are sorted alphabetically but is grouped with other files of the same type.

Here is an example:

In this example, pdf files and html files are grouped separately.

A button that shows up that when clicked will change the url to show that anchor.

Here is an example of how Github does it:

Example

Clicking on a header like the example one immediately above will bring you to #17 (comment)

if there was one, i couldn't find it!

A user may go to a stellar-core page with the url https://www.stellar.org/developers/stellar-core/learn/admin.html. Out of curiosity, the user deletes the learn/admin.html and gets to https://www.stellar.org/developers/stellar-core/. However, that root stellar-core page looks like this:

Why?

This happens because all pages on the developer site is supposed to be under one of the four categories: Learn, Reference, Tools, and Beyond Code. It was decided a while back that some files did not need to be put on the developers site and thus were not categorized (not in a folder with the above name).

There are two solutions

Option 1: Exclude non-categorized files in build process

In the gulp process, instead of symlinking to the project docs page, we can symlink to these specific four folders.

Option 2: Include these files by categorizing them

This would involve moving the files from the docs folder root to their specific folders.

Similar to this: https://en.wikipedia.org/wiki/Zero-width_space

Except the difference with wordbreaks (<wbr />) is that it won't be copied into plain text (whereas zero width spaces can get into json and cause parse errors).

Make it so that www.stellar.org and this share the same code. Alternatively, stellar.org can just link to the developers site.

Right now, the build process assumes that the build will be hosted online.

We can consider making a mode that compiles the developers site into an more offline-friendly archive. It can compressed well (zip, tar.gz, bzip2) to save bandwidth. Then, we can have weekly builds on the releases page. This way, people connected to free wifi can download the archive when bandwidth is cheap for them and view offline without using extra bandwidth.

If we are going with collapsable side nav I think it should at least start expanded.

Currently

Ideal

How

After playing with this for several hours I could not find a pure css way that consistently works on all edgecases (nesting, indentation).

I think the best way would be to use javascript to do this. Adjust the sizes on load and on resize.

Ideally, show a hyperlink icon when user "hovers" on a header, like on GitHub:

I wanted to contribute to the developer site.
Followed the steps, installed node modules.
And then when running gulp watch serve it fails because of an unmet dependency :

Take for example: https://www-stg.stellar.org/developers/horizon/reference/path-finding.html

Example on a apple thunderbolt monitor

Or even on a bigger viewport:

It doesn't snap to the side until the viewport fills up until about 2800 pixels wide

https://www.stellar.org/developers/learn/

This is a minor issue, but because the nodes page is actually generated during the build process of developers, there's no corresponding doc in the docs repo for nodes.md.

The quick fix would be just removing the "Edit this doc on Github" link at the bottom of the page.

You can repro this by:

1. Visiting this page
2. Click "Edit this doc in GitHub" in the footer.

Implement the same favicon as on the www.stellar.org/ site.

You can view the source at the Stellar homepage:

<!-- favicon support is a bit shoddy -->
<link rel="apple-touch-icon" sizes="144x144" href="//www.stellar.org/wp-content/themes/stellar/favicon/rocket-144x144.png">
<link rel="apple-touch-icon" sizes="152x152" href="//www.stellar.org/wp-content/themes/stellar/favicon/rocket-152x152.png">
<link rel="apple-touch-icon" sizes="180x180" href="//www.stellar.org/wp-content/themes/stellar/favicon/rocket-180x180.png">
<link rel="icon" type="image/png" href="//www.stellar.org/wp-content/themes/stellar/favicon/rocket-96x96.png" sizes="96x96">
<meta name="msapplication-TileImage" content="https://www.stellar.org/wp-content/themes/stellar/favicon/rocket-144x144.png">

The developers site should host the files (as opposed to hotlinking to stellar.org/wp-content).

I noticed that some of examples in developer portal are not working (again) because of API changes. To solve this problem I want to add examples tests to our JS SDK. Instead of copying updated examples to markdown files after each edit it would be great to be able to include other file (example file) from markdown files.

So for example:

## Building requests
js-stellar-sdk uses the [Builder pattern](https://en.wikipedia.org/wiki/Builder_pattern) to create the requests to send
to Horizon. Starting with a [server](../reference/server.md) object, you can chain methods together to generate a query.
(See the [Horizon reference](https://www.stellar.org/developers/reference/) documentation for what methods are possible.)
```js
var StellarSdk = require('stellar-sdk')
var server = new StellarSdk.Server('https://horizon-testnet.stellar.org');
// get a list of transactions that occurred in ledger 1400
server.transactions()
    .forLedger(1400)
    .call().then(function(r){ console.log(r); });

// get a list of transactions submitted by a particular account
server.transactions()
    .forAccount('GASOCNHNNLYFNMDJYQ3XFMI7BYHIOCFW3GJEOWRPEGK2TDPGTG2E5EDW')
    .call().then(function(r){ console.log(r); });
``'

Would become something like this:

## Building requests
js-stellar-sdk uses the [Builder pattern](https://en.wikipedia.org/wiki/Builder_pattern) to create the requests to send
to Horizon. Starting with a [server](../reference/server.md) object, you can chain methods together to generate a query.
(See the [Horizon reference](https://www.stellar.org/developers/reference/) documentation for what methods are possible.)
```js
@@include ../examples/transactions.js@@
``'

When in development, it would be nice to have gulp somehow reload the browser when changes to the site are made.

Proposal: Let arbitrary example types occupy a space in the example

This would let multiple examples for a single language to exist on the bar. This could also allow us to introduce more complex examples (like multiple examples) with accompanying explanation text.

Quick example mockup

There is a disparity between streaming examples and "regular" language examples. A language can only have at most one code example.

In accounts-all, the streaming example is displayed as if it were content:

While the other examples get to occupy a tab:

seems to be the ones with a horizontal scroll bar.
look at first curl example: https://www.stellar.org/developers/learn/get-started/get-started.html

Add here, on both sidebar and main body: https://www.stellar.org/developers/reference/

It took me a little while to find it earlier today (https://github.com/Inbot/inbot-stellar-kotlin-wrapper), it's active, and it's probably preferable to Android devs over our vanilla Java SDK.

This is a issue that is straight forward to contribute

Here is an example of where toml is used: https://github.com/stellar/docs/blob/master/learn/concepts/stellar-toml.md

Places to edit:

1. https://github.com/stellar/developers/blob/master/src/js/syntaxHighlight.js#L7
2. https://github.com/stellar/developers/blob/master/gulpfile.babel.js#L41

The Terms of Service and Privacy Policy links should be aligned to the right.

This can be done by using flex-direction: row-reverse and margin left on link items (as opposed to right).

https://www.stellar.org/developers/horizon/reference/orderbook-details.html

Something like this

Except with an icon made by Stellar.

There doesn't seem to be a repo for the main website, so I'm leaving this here.

On https://www.stellar.org/how-it-works/stellar-basics/ bottom right corner seem to suggest something was intended to be commented out:

It looks like changes to JS SDK broke builds:

ERROR: Unable to find the source file or directory /app/repos/js-stellar-sdk/libdocs

[12:50:29] 'generate-sdk-symbols' errored after 1.33 min
[12:50:29] Error: ERROR: Unable to find the source file or directory /app/repos/js-stellar-sdk/libdocs

    at formatError (/usr/local/lib/node_modules/gulp/node_modules/gulp-cli/lib/versioned/^3.7.0/format-error.js:20:10)
    at Gulp.<anonymous> (/usr/local/lib/node_modules/gulp/node_modules/gulp-cli/lib/versioned/^3.7.0/log/events.js:41:15)
    at emitOne (events.js:101:20)
    at Gulp.emit (events.js:188:7)
    at Gulp.Orchestrator._emitTaskDone (/app/node_modules/orchestrator/index.js:264:8)
    at /app/node_modules/orchestrator/index.js:275:23
    at finish (/app/node_modules/orchestrator/lib/runTask.js:21:8)
    at cb (/app/node_modules/orchestrator/lib/runTask.js:29:3)
    at /app/gulpfile.babel.js:97:14
    at ChildProcess.<anonymous> (/app/gulp/code-symbol-tags.js:41:7)
    at emitTwo (events.js:106:13)
    at ChildProcess.emit (events.js:191:7)
    at Process.ChildProcess._handle.onexit (internal/child_process.js:219:12)
[12:50:29] 'src' errored after 1.4 min

@rice2000 @theaeolianmachine you may want to check it out.

This is so that we can make things pretty like this:

Facebook

Slack

We should have a way to lock other repos to particular commits or branches—so we don’t build docs for pre-production features, etc. Also to make it easier to keep everything up-to-date and in-sync.

• Submodules?
• NPM?
• Manually by referencing a commit or branch in repos.json and having better gulp tasks?

On the home page under:

Ask questions and get in touch with 1000+ developers.

Not certain this is intentional, renders the text flush right.