-
Notifications
You must be signed in to change notification settings - Fork 155
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Incorporating a few suggestions to the new docs. #28
Conversation
Preview is available here: |
Docusaurus supports https://katex.org/ and I've added that to this branch |
Preview is available here: |
@briwylde08
@tyvdh
|
@briwylde08
|
@Shaptic Nice! |
@tyvdh thinking about this more, I don't see much math besides the bit I found lol. Do you think the JavaScript cost (e.g. the big file to download + execute) on every page (is it every page? or only pages where you use |
I mean it'll be cached and progressively loaded so it's not a big lift |
Preview is available here: |
Re (2), converting to OpenAPI will definitely help a lot with consistency, but I think adding thorough details like these per-operation error messages is a "phase 2" extension to the spec that will need more work to write and possibly integrate. I just wanted to call it out because we have error and parameter tables for all of the operations in the existing list of operation docs. It may be better to keep them as-is, then replace them with links like done here when the API docs are confirmed to have the same info and level of detail? |
|
3424332
to
4eea30b
Compare
Preview is available here: |
3 similar comments
Preview is available here: |
Preview is available here: |
Preview is available here: |
* update some docs links * update welcome page * added fundamentals and concepts and deleted old start directory * new tools and sdks docs * new glossary * glossary -> encyclopedia * updated encyclopedia * Added code blocks (#10) * Added code blocks Please look at why it won't tab out the code blocks! * added json5 and missing python library Co-authored-by: Tyler van der Hoeven <hi@tyvdh.com> * Added code blocks (#13) * Added missing information to operations (#11) * Added missing information to operations Including: LPs, clawbacks, claimable balances * Update list-of-operations.mdx Co-authored-by: Tyler van der Hoeven <hi@tyvdh.com> * Added code blocks (#14) * delete some dupe content * Added code blocks (#15) * Added code blocks Please look at why it won't tab out the code blocks! * added json5 and missing python library * Added code blocks * spaces matter apparently * nvm Co-authored-by: Tyler van der Hoeven <hi@tyvdh.com> * Added code blocks (#16) * Added code blocks & missing link (#17) * Added code block (#20) * Added code blocks, edited some content (#22) Removed Example 5 (to be added later) * spacing tweaks * Added code blocks (#21) * omit CodeExample block on non code blocks * Added code blocks (#18) * Added code blocks * encyclopedia * space tweak Co-authored-by: Tyler van der Hoeven <hi@tyvdh.com> * Added code blocks (#19) * Added code blocks * removed some spaces Co-authored-by: Tyler van der Hoeven <hi@tyvdh.com> * missed a couple imports * glossary -> encyclopedia * lint * format mdx * no cache on the make * case fix step 1 * case fix step 2 * fixed a link * added another link from the hash * Update sponsored-reserves.mdx * Glossary-Encyclopedia network passphrases * Anchoring assets-xborder payments links * Update setting-up-test-server.mdx * Update withdraw-anchored-assets.mdx * Update custom-assets.mdx * Update first-deposit.mdx * Update project-setup.mdx * Update setup-custodial-account.mdx * Update anatomy-of-an-asset.mdx * Update control-asset-access.mdx * Issuing assets - control asset access * Issuing assets - publishing asset info * run core node - configuring links * Update monitoring.mdx * Tutorials - create account * Update setting-up-production-server.mdx * tutorials - follow received payments links * tutorials - send and receive payments links * run a core node - index links * Added community (#25) Add and update community channels * link tweaks * couple more tweaks * glossary links * issuing assets - anatomy of an asset link * encyclopedia - claimable balance links * encyclopedia - error handling links * encyclopedia - fee bump links * Update fees-surge-pricing-fee-strategies.mdx * Update ledger-headers.mdx * encyclopedia - flags links * Update claimable-balances.mdx * Update error-handling.mdx * Update fee-bump-transactions.mdx * encyclopedia - liquidity on stellar links * encyclopedia - memos links * encyclopedia - path payments links * encyclopedia - pooled accounts links * encyclopedia - signatures and multisig links * encyclopedia - sponsored reserves links * fundamentals & concepts - data strctr - accts links * f&c - data structures - assets links * f&c - data structures - ledgers links * f&c - data structures - operations & transactions links * f&c - operations links * f&c - lumens links * f&c - testnet&pubnet links * updated link in pooled accounts * added sdk library link * minor link tweaks * minor styling update for h4s * oops * updates * Added run a core node link * Remove link to Lumens, not relevant anymore * Fixed a couple of links (#26) Removed .mdx from two links to testnet/pubnet section * Removed unnecessary ) * Added claimable balances link * fix issuing assets link * fixed sep1 link * fixed links to info file and issuing assets * attempt at the first 302 * move nginx conf stuff around * Update redirects.conf * Update redirects.conf * Update nginx.conf * Update nginx.conf * try that? * Update redirects.conf * added SCP link & run api server link * Update redirects.conf * no need for this block * Updating footer (#27) * Updating footer Change developers-community and add community links All tools to link to dev docs tools page Remove get started from resources * update footer content Co-authored-by: Tyler van der Hoeven <hi@tyvdh.com> * noop * Changed links to tables for parameters&errors * Incorporating a few suggestions to the new docs. (#28) * Small improvements to link naming and math rendering * add KaTeX * Change math to use TeX * don't update this Co-authored-by: Tyler van der Hoeven <hi@tyvdh.com> * tiny lint tweaks * Update list-of-operations.mdx * updated table links * Updating ledgerkey definition (#29) * move Lumens under the Stellar Data Structures directory Co-authored-by: Bri <92327786+briwylde08@users.noreply.github.com> Co-authored-by: George <Shaptic@users.noreply.github.com>
This includes a few of my suggestions from Slack, but doesn't include these:
Since these are a little more opinionated and/or involved, so I'll leave those to @briwylde08.