Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Soroban Merge] Create a "Platforms" section (stellar#325)
* API documentation for Soroban-RPC (stellar#253) * Adding the `/api` route to the config, and basic intro content For the moment, I'm essentially copying from the Google Doc. Signed-off-by: Elliot Voris <[email protected]> * Adding content for the `getAccount` method Stubbing in basic file structure for all other methods. Signed-off-by: Elliot Voris <[email protected]> * Expanding the methods in the sidebar by default Signed-off-by: Elliot Voris <[email protected]> * Adding content for `getHealth` method Signed-off-by: Elliot Voris <[email protected]> * Adding content for the `getHealth` method Signed-off-by: Elliot Voris <[email protected]> * Adding content for the `getLatestLedger` method Signed-off-by: Elliot Voris <[email protected]> * Adding content for the `getLedgerEntry` method Signed-off-by: Elliot Voris <[email protected]> * Adding content for the `getContractData` method Signed-off-by: Elliot Voris <[email protected]> * Adding content for the `getEvents` method Signed-off-by: Elliot Voris <[email protected]> * Un-commenting a TODO item Signed-off-by: Elliot Voris <[email protected]> * Adding content for the `getNetwork` method Signed-off-by: Elliot Voris <[email protected]> * Adding content for the `getTransactionStatus` method Signed-off-by: Elliot Voris <[email protected]> * Adding content for the `requestAirdrop` method Signed-off-by: Elliot Voris <[email protected]> * Adding content for the `sendTransaction` method Signed-off-by: Elliot Voris <[email protected]> * Adding content for `simulateTransaction` method Signed-off-by: Elliot Voris <[email protected]> * Changing the appearance of a WIP note Signed-off-by: Elliot Voris <[email protected]> * Breaking each of the intro sections into their own pages Signed-off-by: Elliot Voris <[email protected]> * Hand-writing (most) of the sidebar It's easier to accomplish what I'm after this way. Or, at least, I figured out how to accomplish it this way first. Signed-off-by: Elliot Voris <[email protected]> * Adding a "description" field to the intro category Signed-off-by: Elliot Voris <[email protected]> * Fixing a link reference to `pagination` Signed-off-by: Elliot Voris <[email protected]> * Capitalizing `Stellar` more consistently Signed-off-by: Elliot Voris <[email protected]> * Update api/methods/getEvents.mdx Soroban-RPC supports querying up to 24 hours of recent ledgers. Co-authored-by: Paul Bellamy <[email protected]> * Update api/methods/getTransactionStatus.mdx Co-authored-by: Paul Bellamy <[email protected]> * `sendTransaction` *does* support all Stellar transactions. Signed-off-by: Elliot Voris <[email protected]> * Removing the question about auto-calculating footprints Signed-off-by: Elliot Voris <[email protected]> * All questions have been answered. Sweet!! Signed-off-by: Elliot Voris <[email protected]> * Update api/pagination.mdx Co-authored-by: Paul Bellamy <[email protected]> * Removing the "Outstanding Questions" page from the sidebar Signed-off-by: Elliot Voris <[email protected]> * denoting `getNetwork` as a work-in-progress Signed-off-by: Elliot Voris <[email protected]> * Moving the (WIP) methods to their own sidebar section Signed-off-by: Elliot Voris <[email protected]> * Adding example request/response to the `getAccount` method Signed-off-by: Elliot Voris <[email protected]> * Adding example request/response for the `getHealth` method Signed-off-by: Elliot Voris <[email protected]> * Adding example request/response for the `sendTransaction` method Signed-off-by: Elliot Voris <[email protected]> * Adding example request/response for the `getTransactionStatus` method Signed-off-by: Elliot Voris <[email protected]> * Adding example request/response for the `getContractData` method Signed-off-by: Elliot Voris <[email protected]> * Adding example request/response for the `getLedgerEntry` method Signed-off-by: Elliot Voris <[email protected]> * Changing the `balance` field into a "TODO" Signed-off-by: Elliot Voris <[email protected]> * Adding example request/response for the `getEvents` method Signed-off-by: Elliot Voris <[email protected]> * Adding a note about the events that are returned Signed-off-by: Elliot Voris <[email protected]> * Adding example request/response for the `simulateTransaction` method. Signed-off-by: Elliot Voris <[email protected]> * Adding a pending example to the `getTransactionStatus` method Signed-off-by: Elliot Voris <[email protected]> * Adding a more useful success example to `getTransactionStatus` Signed-off-by: Elliot Voris <[email protected]> * Using a soroban transaction in the `sendTransaction` method Don't forget the footprint, friends! Signed-off-by: Elliot Voris <[email protected]> * Removing the `getContractData` method This method is being deprecated. See stellar/stellar-cli#316 for more details. Please use the `getLedgerEntry` method instead. Signed-off-by: Elliot Voris <[email protected]> Signed-off-by: Elliot Voris <[email protected]> Co-authored-by: Paul Bellamy <[email protected]> * Clarify encoding of hash in the api docs (stellar#282) * Providing an example for retrieving contract code using `getLedgerEntry` (stellar#281) * Providing a (long-winded?) example for retrieving contract code Is this too detailed? Is this even needed? Signed-off-by: Elliot Voris <[email protected]> * Adding a link to lab to help with decoding XDR Signed-off-by: Elliot Voris <[email protected]> * Fine-tuning the explanation of the `ContractCode` LedgerEntry Shuffling some things around a bit, and giving a better overview of the contract deployment process for Soroban. Co-authored-by: Paul Bellamy <[email protected]> Signed-off-by: Elliot Voris <[email protected]> Signed-off-by: Elliot Voris <[email protected]> Co-authored-by: Paul Bellamy <[email protected]> * update all admonitions such that prettier doesn't yell * Reorg (stellar#290) * Change SDK section to Reference section * Adding JS SDK to list of SDKs * Adding Overcat's Python SDK to list of SDKs * Moving Networks -> Futurenet to Reference section * Moving Releases to Reference section * Delete Networks from main nav Networks now lives under Reference section * Deleting as Releases now live in Reference section * Changing sidebar position Temporary, this will eventually move to How-To Guides * Update byo.mdx * Edited Quick Start to 1. Hello World Includes Tutorials -> Create a Project / Write a Contract / Test / Build / Run on Sandbox / Optimizing Builds * Move Storing Data from Examples to Getting Started * Move Deploy to Local Network to Getting Started Moved this section from Tutorials to Getting Started * Move Freighter wallet tutorial to Getting Started * Update and rename 6.-connect-Freighter-wallet.mdx to 4. Connect Freighter Wallet * Move Deploy to Futurenet to Getting Started * Rename 4. Connect Freighter Wallet to 4. Connect Freighter Wallet.mdx * Moved to Getting Started * Moved to Getting Started Removing this section * Moved to Getting Started Removing this as it has been moved to Getting Started * Moved to Getting Started -> Hello World * Moved to Getting Started -> Hello World * Moved to Getting Started -> Hello World * Moved to Getting Started -> Hello World * Moved to Getting Started -> Hello World * Moved to Getting Started -> Hello World * Moved to Getting Started Removing due to this section being moved * Update Examples to How-To Guides * Move BYO SDK to How-To Guides * Moved to How-To Guides * Moved invoking contracts with transactions to How-To Guides * Removing because it's moved to How-To Guides * Moved Token Interface to Token How-To Guide * Remove Token Interface Token Interface has been moved to How-To Guides -> Token * Move Stellar Asset Contract to How-To Guides * Delete docs/built-in-contracts directory Moved to How-To Guides * Move Stellar FAQs to Learn * Delete faq.mdx Moved to Learn * Update authorization.mdx Alphabetize sidebar * Update contract-lifecycle.mdx Alphabetizing sidebar * Update custom-types.mdx Alphabetizing sidebar * Update rust-dialect.mdx Alphabetizing sidebar * Update debugging.mdx Alphabetizing sidebar * Update environment-concepts.mdx Alphabetizing sidebar * Update errors.mdx Alphabetizing sidebar * Update events.mdx Alphabetizing sidebar * Update gas-and-metering.mdx Alphabetizing sidebar * Update interacting-with-contracts.mdx Alphabetizing sidebar * Update persisting-data.mdx Alphabetizing sidebar * Update high-level-overview.mdx Update spelling * formatting * formatting * formatting * formatting * Update faq.mdx * fixed broken links * fix broken links * fix broken links * moar link fixes * fixed some broken links * added sorobanathon homepage * add google tag manager * Content edits made * back to original * Content Edit * button location * Content & Eligibility guidelines added * Update sorobanathon.js * update all admonitions such that prettier doesn't yell * Lots of formatting * --prose-wrap preserve * Update releases.mdx * update prettier * fixed the callouts * formatting * fix module import * Update sorobanathon.js * Fixed Reorg PR Fixed links, moved sections, deleted double sections * Update index.js * Updating Sorobanathon Info * Fixed links Many links. * Formatting * Change SDK section to Reference section * Adding JS SDK to list of SDKs * Adding Overcat's Python SDK to list of SDKs * Moving Networks -> Futurenet to Reference section * Moving Releases to Reference section * Delete Networks from main nav Networks now lives under Reference section * Deleting as Releases now live in Reference section * Changing sidebar position Temporary, this will eventually move to How-To Guides * Update byo.mdx * formatting * fix broken links * Edited Quick Start to 1. Hello World Includes Tutorials -> Create a Project / Write a Contract / Test / Build / Run on Sandbox / Optimizing Builds * Move Storing Data from Examples to Getting Started * Move Deploy to Local Network to Getting Started Moved this section from Tutorials to Getting Started * Move Freighter wallet tutorial to Getting Started * Update and rename 6.-connect-Freighter-wallet.mdx to 4. Connect Freighter Wallet * Move Deploy to Futurenet to Getting Started * Rename 4. Connect Freighter Wallet to 4. Connect Freighter Wallet.mdx * Moved to Getting Started Removing this as it has been moved to Getting Started * Moved to Getting Started -> Hello World * Moved to Getting Started -> Hello World * formatting * fix broken links * moar link fixes * Update Examples to How-To Guides * Move BYO SDK to How-To Guides * Moved invoking contracts with transactions to How-To Guides * Moved Token Interface to Token How-To Guide * Remove Token Interface Token Interface has been moved to How-To Guides -> Token * Move Stellar Asset Contract to How-To Guides * Delete docs/built-in-contracts directory Moved to How-To Guides * formatting * fixed broken links * Move Stellar FAQs to Learn * Update authorization.mdx Alphabetize sidebar * Update contract-lifecycle.mdx Alphabetizing sidebar * Update custom-types.mdx Alphabetizing sidebar * Update rust-dialect.mdx Alphabetizing sidebar * Update debugging.mdx Alphabetizing sidebar * Update environment-concepts.mdx Alphabetizing sidebar * Update errors.mdx Alphabetizing sidebar * Update events.mdx Alphabetizing sidebar * Update gas-and-metering.mdx Alphabetizing sidebar * Update interacting-with-contracts.mdx Alphabetizing sidebar * Update persisting-data.mdx Alphabetizing sidebar * Update high-level-overview.mdx Update spelling * formatting * Update faq.mdx * fixed some broken links * Update releases.mdx * update prettier * fixed the callouts * formatting * fix module import * Fixed Reorg PR Fixed links, moved sections, deleted double sections * Fixed links Many links. * Formatting * Merge cleanup * More cleanup * Formatting * some small design tweaks * copy tweaks --------- Co-authored-by: Bri <[email protected]> Co-authored-by: Anuxhya <[email protected]> * Update documentation to reflect recent getEvents changes (stellar#293) In stellar/stellar-cli#385 we modified the getEvents endpoint to remove the endLedger param and changed the behavior of pagination * Merge dev docs to main (stellar#316) * proposed auth-next support for simulateTransaction method * Add note about multiple results * auth is an array * Updated example docs for Auth Next. (stellar#306) * Updated example docs for Auth Next. * Update token documentation for Auth Next (stellar#307) * Update token doc to use auth next. * Add AUTH_REQUIRED section * Mention set_auth and link to classic docs * feat: update for upcoming CLI version * feat: CLI reference page * Update optimize contracts section (stellar#310) * Update hello-world.mdx * Update hello-world.mdx * don't need to manually install wasm-opt via binaryen * remove the -Z flags * More Auth Next docs updates (stellar#311) * Remove rust-auth.mdx * Update authorization docs and `Address` type info. * Added auth info to transactions doc. * Added a document about migrating to auth next. * Add some high-level docs for Auth Next preflight (stellar#312) * Add some preflight information for Auth Next * Update docs/reference/command-line.mdx * Update docs/reference/releases.mdx * Update docs/reference/releases.mdx * Update simulateTransaction.mdx * Update examples to point to 0.6.0 * Update releases page to current state * Add change log for cli and rpc * Added a note on the breaking auth changes to the release notes. (stellar#315) --------- Co-authored-by: Paul Bellamy <[email protected]> Co-authored-by: Siddharth Suresh <[email protected]> Co-authored-by: Chad Ostrowski <[email protected]> Co-authored-by: Willem Wyndham <[email protected]> Co-authored-by: Tyler van der Hoeven <[email protected]> Co-authored-by: Paul Bellamy <[email protected]> * Update documentation for getTransaction() and sendTransaction() (stellar#336) * Clean up page descriptions in category indexes (stellar#348) * Add descriptions to docs that appear in generated category indexes. * Add category indexes and descriptions for SDKs and interfaces * Clean up descriptions of API documents. * compile -> create * remove apostrophe * added oxford comma * capitalization * added oxford comma --------- Co-authored-by: Bri <[email protected]> * Add new diagnostic filter type to getEvents method (stellar#349) --------- Co-authored-by: tamirms <[email protected]> * Update getEvents documentation to include event type csv (stellar#353) * Add `events` response field to simulateTransaction method (stellar#354) * Merge pull request stellar#319 from paulbellamy/dev Soroban-RPC updates for the release * Remove out of date file * Remove the deprecated (and now removed) getAccount soroban-rpc method * Updated docs for getLatestLedger * Update return obj descriptions * API: Update simulateTransaction RPC method to include fee support (stellar#439) * API: Update simulateTransaction RPC method to include fee support * stop using the increment example * Update api/methods/simulateTransaction.mdx Co-authored-by: Paul Bellamy <[email protected]> * Address review feedback --------- Co-authored-by: Paul Bellamy <[email protected]> * Update API method documentation (stellar#445) * Update XDR in JSON examples * replace `getLedgerEntry` by `getLedgerEntries` * Update API method documentation (stellar#445) * Update XDR in JSON examples * replace `getLedgerEntry` by `getLedgerEntries` * API: fix parameter description in getLedgerEntries (stellar#457) * API: fix parameter description in getLedgerEntries (stellar#457) * Update getLedgerEntries docs. (stellar#472) * Update getLedgerEntries docs. (stellar#472) * Release Preview 10 (stellar#480) * Change command recommended for building .wasm files for deployment (stellar#476) * Fix logging example (stellar#481) * Update docs with auth XDR changes. (stellar#483) * Update docs with auth XDR changes. * WASM->Wasm rename. Wasm is the official abbreviation of WebAssembly. * Typo fixes (stellar#484) * Add fuzzing docs. (stellar#486) * State expiration operations and token updates (stellar#485) * Add docs for state expiration operations * Updates * update token * Update custom account * More token updates * Update atomic swap * More detailed state expiration docs (stellar#492) * More fixes (stellar#489) * More fixes * Add approve warning * Update releases page * Fix link * Update example links from 0.8.4 to 0.9.2 * fix link * Fixed instance bump bug in docs (stellar#493) --------- Co-authored-by: Dmytro Kozhevin <[email protected]> Co-authored-by: Brian Anderson <[email protected]> Co-authored-by: Siddharth Suresh <[email protected]> Co-authored-by: Garand Tyson <[email protected]> Co-authored-by: Julian Martinez <[email protected]> * Release Preview 10 (stellar#480) * Change command recommended for building .wasm files for deployment (stellar#476) * Fix logging example (stellar#481) * Update docs with auth XDR changes. (stellar#483) * Update docs with auth XDR changes. * WASM->Wasm rename. Wasm is the official abbreviation of WebAssembly. * Typo fixes (stellar#484) * Add fuzzing docs. (stellar#486) * State expiration operations and token updates (stellar#485) * Add docs for state expiration operations * Updates * update token * Update custom account * More token updates * Update atomic swap * More detailed state expiration docs (stellar#492) * More fixes (stellar#489) * More fixes * Add approve warning * Update releases page * Fix link * Update example links from 0.8.4 to 0.9.2 * fix link * Fixed instance bump bug in docs (stellar#493) --------- Co-authored-by: Dmytro Kozhevin <[email protected]> Co-authored-by: Brian Anderson <[email protected]> Co-authored-by: Siddharth Suresh <[email protected]> Co-authored-by: Garand Tyson <[email protected]> Co-authored-by: Julian Martinez <[email protected]> * Clarify that there is always 0 or 1 item in `results` (stellar#506) Co-authored-by: Tyler van der Hoeven <[email protected]> * Add javascript example to get the WASM content (stellar#473) * Add javascript example to get the WASM content * Update to preview 10 * Add javascript example to get the WASM content (stellar#473) * Add javascript example to get the WASM content * Update to preview 10 * Update soroban-rpc docs (stellar#551) * Add new fields * Move optionality explanations to the ends * Make the documention of every field consistent * Remove multiple results from the example (since multiop transactions are not supported) * Update simulateTransaction.mdx (stellar#567) Improved readability for the description of the `restorePreamble` in the RPC response * feat: Display example RPC requests as a useable CURL command (stellar#568) Also displaying generic code snippets for popular languages, as well as in raw JSON format. A new `ExampleRequest` component has been made to facilitate this, as well. This component takes a `method` prop for the name of the RPC method being called, as well as an optional `params` prop which can pass the object that should be used to populate the RPC request object. Refs: stellar#565 * feat: Display example RPC requests as a useable CURL command (stellar#568) Also displaying generic code snippets for popular languages, as well as in raw JSON format. A new `ExampleRequest` component has been made to facilitate this, as well. This component takes a `method` prop for the name of the RPC method being called, as well as an optional `params` prop which can pass the object that should be used to populate the RPC request object. Refs: stellar#565 * Update Futurenet to Testnet Across Documentation (stellar#577) * Futurenet -> Testnet * fix broken links * update-rpc-page * Update testnet.mdx * Pass 1 * format * update table in testnet.mdx * update state expiration example script to use testnet * replacing futurenet with testnet in contract deployment example * revert SDC contnet * include testnet network passphrase on releases page * update freighter to include testnet alongside futurenet * revert SDC to Use Futurenet for the time being * style: fix up markdown syntax and style in `rpc.mdx` Also adds some small linguistic and grammer changes, as well as more updates from Futurenet to Testnet * docs: include Testnet when describing what RPC servers SDF maintains * style: changing a single ellipsis character with three periods * docs: include gh repo links to the software that runs in quickstart * add the Testnet network to the example `initialize.sh` script * change contract-invoking transaction example code to use Testnet * change to valid futurenet URLs in dapp challenges * Apply suggestions from code review minor tweaks that slipped through the cracks --------- Co-authored-by: Elliot Voris <[email protected]> * Update Futurenet to Testnet Across Documentation (stellar#577) * Futurenet -> Testnet * fix broken links * update-rpc-page * Update testnet.mdx * Pass 1 * format * update table in testnet.mdx * update state expiration example script to use testnet * replacing futurenet with testnet in contract deployment example * revert SDC contnet * include testnet network passphrase on releases page * update freighter to include testnet alongside futurenet * revert SDC to Use Futurenet for the time being * style: fix up markdown syntax and style in `rpc.mdx` Also adds some small linguistic and grammer changes, as well as more updates from Futurenet to Testnet * docs: include Testnet when describing what RPC servers SDF maintains * style: changing a single ellipsis character with three periods * docs: include gh repo links to the software that runs in quickstart * add the Testnet network to the example `initialize.sh` script * change contract-invoking transaction example code to use Testnet * change to valid futurenet URLs in dapp challenges * Apply suggestions from code review minor tweaks that slipped through the cracks --------- Co-authored-by: Elliot Voris <[email protected]> * Clarify that IDs are strkeys, plus minor lang cleanup (stellar#605) * update getLedgerEntries documentation (stellar#614) * update * update per feedback, * update getLedgerEntries documentation (stellar#614) * update * update per feedback, * Reworked documentation of Soroban RPC methods using open-rpc-docs-react component to be consistent with Anchor API (stellar#603) * Reworked documentation of Soroban RPC methods using open-rpc-docs-react component to be consistent with Anchor API * Merged latest changes from main and adjusted descriptions * Updated docs for getLedgerEntries RPC call. Fixed typescript error. * Reworked documentation of Soroban RPC methods using open-rpc-docs-react component to be consistent with Anchor API (stellar#603) * Reworked documentation of Soroban RPC methods using open-rpc-docs-react component to be consistent with Anchor API * Merged latest changes from main and adjusted descriptions * Updated docs for getLedgerEntries RPC call. Fixed typescript error. * rpc: rename expirationLedgerSeq to liveUntilLedgerSeq (stellar#625) * rpc: rename expirationLedgerSeq to liveUntilLedgerSeq * rpc: rename expiration ledger in openrpc file --------- Co-authored-by: Elliot Voris <[email protected]> * rpc: rename expirationLedgerSeq to liveUntilLedgerSeq (stellar#625) * rpc: rename expirationLedgerSeq to liveUntilLedgerSeq * rpc: rename expiration ledger in openrpc file --------- Co-authored-by: Elliot Voris <[email protected]> * Update WASM retrieval tutorial (stellar#627) * Update WASM retrieval tutorial (stellar#627) * Upgrade `getLedgerEntries` examples to latest pre-stable releases of the SDKs (stellar#635) Co-authored-by: Elliot Voris <[email protected]> * Upgrade `getLedgerEntries` examples to latest pre-stable releases of the SDKs (stellar#635) Co-authored-by: Elliot Voris <[email protected]> * Integrate a complete `openrpc.json` document (stellar#647) * docs: move data providers page out of sdks directory * restarting effort to integrate a full openrpc.json spec file * more random stuff... some of it is good and works well * docs: put everything into one `openrpc.json` document - modify the metamask package to display things a little nicer - generate openrpc.json file from a compound schema (in another repo soon) - add more react components to the `<Method />` component * style: customize metamask style for examples select box * docs: remove examples from within the mdx pages * docs: add descriptions to each of the method pages * docs: including a description of the OpenRPC spec * docs: rename sidebar category to simply "Methods" * Integrate a complete `openrpc.json` document (stellar#647) * docs: move data providers page out of sdks directory * restarting effort to integrate a full openrpc.json spec file * more random stuff... some of it is good and works well * docs: put everything into one `openrpc.json` document - modify the metamask package to display things a little nicer - generate openrpc.json file from a compound schema (in another repo soon) - add more react components to the `<Method />` component * style: customize metamask style for examples select box * docs: remove examples from within the mdx pages * docs: add descriptions to each of the method pages * docs: including a description of the OpenRPC spec * docs: rename sidebar category to simply "Methods" * Fix openrpc playground urls (stellar#649) * docs: use a github link for OpenRPC json file * docs: use gh url instead of static file * synchronize api example tabs across pages (stellar#661) * State archival refactor (stellar#678) * State archival refactor * Small fixes * Add v20.0.0 (stellar#668) * add P12 Release * formatting * Update releases.mdx * formatting * update horizon,stellar-base,cli * add stellar sdk + base, soroban-client, Quickstart, changelog * remove http from quickstart endpoint * v20.0.0-rc2 -> v20.0.0 * Preview 12 -> Stable v20.0.0 * update CLI, RPC, Core Versions * update stellar cor version * Content updates to go along with the preview 12 version updates (stellar#682) * update the token interface to reflect the Rust SDK * feat: get Getting Started ready for v20.0.x I don't know what the exact version of the CLI will be out by next Monday. In the source here, I've guessed that maybe it will be `20.0.3`. * update `openrpc.json` file to reflect new updates * Update static/openrpc.json Co-authored-by: Alfonso Acosta <[email protected]> --------- Co-authored-by: Chad Ostrowski <[email protected]> Co-authored-by: Molly Karcher <[email protected]> Co-authored-by: Alfonso Acosta <[email protected]> * Update token-interface.mdx * nit:formatting --------- Co-authored-by: Elliot Voris <[email protected]> Co-authored-by: Chad Ostrowski <[email protected]> Co-authored-by: Molly Karcher <[email protected]> Co-authored-by: Alfonso Acosta <[email protected]> * soroban-docs: Update simulateTransaction Docs With New resourceConfig Parameter (stellar#683) * Update docs for new resourceConfig param in simulateTransaction * add examples for `resourceConfig` param --------- Co-authored-by: Elliot Voris <[email protected]> * Update JavaScript SDK references to use the `@stellar/stellar-sdk` package (stellar#687) * Upgrade js sdk dependencies to latest * Track down references to soroban-client and move them * Ran linter * Update JavaScript SDK references to use the `@stellar/stellar-sdk` package (stellar#687) * Upgrade js sdk dependencies to latest * Track down references to soroban-client and move them * Ran linter * Update the state archival JavaScript tutorial (stellar#698) * Update the state archival JavaScript tutorial (stellar#698) * api: add new diagnosticEventsXdr field in sendTransaction response (stellar#700) * Pre mainnet restructure (stellar#644) * docs: rename "fundamentals and concepts" to "soroban internals" * docs: remove old "under the hood" section * docs: add tags to the various tutorials * docs: move tutorials into one main directory * fix broken links to old pages * docs: renaming soroban internals in category file * docs: remove old "command line reference" category * docs: add tokens directory, rearrange sidebars * docs: rearrange migration from evm guide * docs: remove unused reference/interfaces category * docs: move "reference" section to "resources" * docs: move "releases" page up a level * docs: move FAQ page up one level * docs: move dev tools into resources directory * docs: move testnet.mdx to networks.mdx * docs: rearrange items in resources directory * docs: collapse various SDK pages into two pages * docs: move data-providers up one level * docs: remove some empty categories, move the tutorial template * docs: add a new getting-started page, reorganize that section * docs: change sidebar position integers in soroban-internals * docs: shuffling contract interaction around in soroban-internals * style: fixing a couple small markdown nits in dapps directory * docs: fix a broken link * feat: start to the "guides" page(s) * style(lint): fixing a small linting error * remove guides placeholder * fixing broken links * work on guides listing. might revert this * formatting mdx * docs: fixing a broken link to tutorials * style: crack at making the tutorials filterable and hidden in the sidebar * customizing some components for the `/guides` pages and layouts * rename index page for guides to README * remove commented configuration option * remove some console logging in components * change name of index page in guides sidebar * remove commented sidebar generation code * remove comments and add description to sidebar generator * rename sidebar generator file * more work on how the 'guides' pages might look. * docs: adjusting sidebar positions of new getting started pages * fix some broken links in the getting-started section * prefer "README.mdx" files where possible * some more guides placeholder stubs * docs(guides): More placeholder stubs for guides and categories * feat: don't display "guides in category" page on `/guides` * build: check/fix MDX formatting in more directories than just docs * style: add a larger margin before more category guides * style: more selectively increase that top margin * docs(guides): a quick stab at a "publishing" events guide * docs(guides): first stab at the "publish events" guide * docs: updating tutorial descriptions * fix a few broken links * docs: add note about a tuple with one element * style: couple link changes and reformats * move fuzzing tutorial back * change to README file in contract interactions category * docs(guides): give a better title for the wasm metadata guide * fixing some broken markdown links * fix (another!) broken link * move the guides back into the main layout of the docs directory * add placeholder for testnet reset automation stuff * some initial content for some guides * markdown formatting and fixing broken links * moving "resources" back to "reference" to fit the definition better More like "technical reference" rather than a "reference encyclopedia" * change some styles of the tutorial list * removing most category pages * some more first-drafts of guides * fixing some category links * include a period at the end of each tutorial description * simplify tutorial search box placeholder text * better description for the tutorials page * making the pre-commit script executable * flesh out some of the state archival guides * first effort for some rpc ledger key guides * fix some broken links * add a guide on ingesting events into a db * first effort at storage type guides * Some more stubs, marking drafts, and a couple additions * make not a draft to fix a broken link * guides category descriptions in README.mdx files * marking incomplete chain migration docs as drafts * change some tutorial difficulty levels * fine-tune the tutorials component styling a bit * improving some guides organization * fix linting errors and broken links * include wrap instructions for native lumens * fix broken link in contract metadata guide * final changes to existing guides * moving developer tools into the main sidebar * create real redirects instead of just notes * fix broken links in a dapps challenge page * fix a redirect syntax error * fix a tutorials redirect * Pre mainnet restructure (stellar#644) * docs: rename "fundamentals and concepts" to "soroban internals" * docs: remove old "under the hood" section * docs: add tags to the various tutorials * docs: move tutorials into one main directory * fix broken links to old pages * docs: renaming soroban internals in category file * docs: remove old "command line reference" category * docs: add tokens directory, rearrange sidebars * docs: rearrange migration from evm guide * docs: remove unused reference/interfaces category * docs: move "reference" section to "resources" * docs: move "releases" page up a level * docs: move FAQ page up one level * docs: move dev tools into resources directory * docs: move testnet.mdx to networks.mdx * docs: rearrange items in resources directory * docs: collapse various SDK pages into two pages * docs: move data-providers up one level * docs: remove some empty categories, move the tutorial template * docs: add a new getting-started page, reorganize that section * docs: change sidebar position integers in soroban-internals * docs: shuffling contract interaction around in soroban-internals * style: fixing a couple small markdown nits in dapps directory * docs: fix a broken link * feat: start to the "guides" page(s) * style(lint): fixing a small linting error * remove guides placeholder * fixing broken links * work on guides listing. might revert this * formatting mdx * docs: fixing a broken link to tutorials * style: crack at making the tutorials filterable and hidden in the sidebar * customizing some components for the `/guides` pages and layouts * rename index page for guides to README * remove commented configuration option * remove some console logging in components * change name of index page in guides sidebar * remove commented sidebar generation code * remove comments and add description to sidebar generator * rename sidebar generator file * more work on how the 'guides' pages might look. * docs: adjusting sidebar positions of new getting started pages * fix some broken links in the getting-started section * prefer "README.mdx" files where possible * some more guides placeholder stubs * docs(guides): More placeholder stubs for guides and categories * feat: don't display "guides in category" page on `/guides` * build: check/fix MDX formatting in more directories than just docs * style: add a larger margin before more category guides * style: more selectively increase that top margin * docs(guides): a quick stab at a "publishing" events guide * docs(guides): first stab at the "publish events" guide * docs: updating tutorial descriptions * fix a few broken links * docs: add note about a tuple with one element * style: couple link changes and reformats * move fuzzing tutorial back * change to README file in contract interactions category * docs(guides): give a better title for the wasm metadata guide * fixing some broken markdown links * fix (another!) broken link * move the guides back into the main layout of the docs directory * add placeholder for testnet reset automation stuff * some initial content for some guides * markdown formatting and fixing broken links * moving "resources" back to "reference" to fit the definition better More like "technical reference" rather than a "reference encyclopedia" * change some styles of the tutorial list * removing most category pages * some more first-drafts of guides * fixing some category links * include a period at the end of each tutorial description * simplify tutorial search box placeholder text * better description for the tutorials page * making the pre-commit script executable * flesh out some of the state archival guides * first effort for some rpc ledger key guides * fix some broken links * add a guide on ingesting events into a db * first effort at storage type guides * Some more stubs, marking drafts, and a couple additions * make not a draft to fix a broken link * guides category descriptions in README.mdx files * marking incomplete chain migration docs as drafts * change some tutorial difficulty levels * fine-tune the tutorials component styling a bit * improving some guides organization * fix linting errors and broken links * include wrap instructions for native lumens * fix broken link in contract metadata guide * final changes to existing guides * moving developer tools into the main sidebar * create real redirects instead of just notes * fix broken links in a dapps challenge page * fix a redirect syntax error * fix a tutorials redirect * Generate the `openrpc.json` specification file in this repo (stellar#692) * move specfile generation into this repo * add a readme to the openrpc directory, ignore transitional files * add spec generation to docker file * test change to `getEvents` method * Revert "test change to `getEvents` method" This reverts commit 978b8b0f54c794fe59b83f2f1e866794bfc7b917. * remove console statements in build script * add note about the build process at deploy time * updating build with newest fields * Update RPC docs for clarify on deprecation of postional array and costs (stellar#721) * Update RPC docs for clarify on deprecation of postional array and costs * Update description on costs * Update in JSON-RPC info * Update transaction desc * Add build file * remove an extra file * modify the patch for the openrpc react package this will display our custom note following the parameters heading and before any of the named parameters are listed * remove the notes about by-name parameters in transaction params * add `deprecated` to the `cost` object in the tx simulation result * add the built `openrpc.json` file --------- Co-authored-by: Jane Wang <[email protected]> Co-authored-by: Elliot Voris <[email protected]> * Fix case of parameter (stellar#727) * use by-name params in pagination example (stellar#743) Refs: stellar#728 * create platforms section of docs - move a `/api` directory to be `/platforms` - move admin guides for horizon, anchor platform, sdp into their respective "platform" sections * modify sidebars * rename sidebar generator for api/platforms docs * re-order admin guides for the various platforms * fix broken links * custom css for dropdown "sections" in the platforms navbar item * change `/api` -> `/platforms` in custom sidebar component * docusaurus config changes * fix typo in sdp filepath * fix more broken links * change rpc filepath to reflect "platforms" language * fix broken links and setup soroban-rpc sidebar * install required packages for soroban rpc methods * modify custom RpcMethod component to handle a single rpc doc * specify `platform=soroban` for these methods * add soroban-rpc to Platforms dropdown menu * remove sdp from the docs sidebar, since it is now in platforms * custom css for metmask openrpc package * fix a broken link * update URLs in openrpc specfile * rename admin guide directories * use the default layout for admin guide pages * fix some broken links * Add Hubble to Platforms tab * display admin guide docs with default DocItem component * specify the slug for the hubble overview page * include hubble pages in the default DocItem component check * remove unnecessary console statement * fix broken links * move soroban rpc intro files into a consisten folder * move new anchor platform events docs into place * fix broken links * improve text in platforms index page * Add Introduction to Horizon -Change original "Introduction" to "Structure" -Include Introduction for Horizon * fix broken links * use the default DocItem component for soroban-rpc pages, too * Add RPC providers and usage to RPC section * Change Hubble Overview to Introduction to align * Add Horizon Introduction content * Shuffle RPC sections * use README.mdx conventions in anchor platform admin guide * fix broken links * use README.mdx conventions in horizon * use README.mdx convention for soroban-rpc * fix link, formatting * fix more broken links * use README.mdx conventions in sdp * fix a whole bunch of broken links * Horizon structural changes * Update outdated code. (stellar#759) * nicer look for menu dropdown subtitles * expand soroban rcp methods category by default * move core node docs to "Network" section * rename platforms to network * fix broken links, styles, etc. * use default DocItem for core-node docs * add link to Network dropdown and style the active dropdown item * more README.mdx uses in anchor platform * fix broken links * change filepaths in redocly scripts `api/` -> `network/` * first stab at nginx redirects * use more README.mdx in horizon * more README.mdx files in horizon * more README.mdx files (almost done i think?) * final batch of README.mdx files * change platforms to network in soroban-rpc openrpc URLs * fix a broken link * add the rpcspec command to the docker build file * move updated getLedgerEntries page into the correct location --------- Signed-off-by: Elliot Voris <[email protected]> Co-authored-by: Paul Bellamy <[email protected]> Co-authored-by: Paul Bellamy <[email protected]> Co-authored-by: Tyler van der Hoeven <[email protected]> Co-authored-by: Bri <[email protected]> Co-authored-by: Anuxhya <[email protected]> Co-authored-by: tamirms <[email protected]> Co-authored-by: Dmytro Kozhevin <[email protected]> Co-authored-by: Siddharth Suresh <[email protected]> Co-authored-by: Chad Ostrowski <[email protected]> Co-authored-by: Willem Wyndham <[email protected]> Co-authored-by: Brian Anderson <[email protected]> Co-authored-by: Alfonso Acosta <[email protected]> Co-authored-by: Tyler.S <[email protected]> Co-authored-by: stellarsaur <[email protected]> Co-authored-by: Jun Luo <[email protected]> Co-authored-by: Leigh McCulloch <[email protected]> Co-authored-by: Garand Tyson <[email protected]> Co-authored-by: Julian Martinez <[email protected]> Co-authored-by: George <[email protected]> Co-authored-by: Vincent Amouret <[email protected]> Co-authored-by: Julian Martinez <[email protected]> Co-authored-by: Tsachi Herman <[email protected]> Co-authored-by: MazurakIhor <[email protected]> Co-authored-by: Molly Karcher <[email protected]> Co-authored-by: Jane Wang <[email protected]> Co-authored-by: Jane Wang <[email protected]>
- Loading branch information
27 people
authored
Mar 5, 2024
1 parent
3a65957
commit aae1682