This repository has been archived by the owner on Aug 21, 2024. It is now read-only.
Merge main into dev #305
Merged
Merge main into dev #305
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Merge dev into main for the next release
Merge dev into main to pick up alloc docs
Add token example to docs
* 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]>
…ry` (#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]>
Add sorobanathon landing page
* 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]>
* Editing Soroban docs footer Added/edited new sections: About, Community, and Resources * update sorobanathon link --------- Co-authored-by: Tyler van der Hoeven <[email protected]>
I had one of my devs try the Windows install and when you look at the existing docs, it looks like installing the wasm target is just for macOS/Linux/Unix-like systems. Moving it below the Windows section and making it it's own section might help.
* add soneso sdks * update maintainer text
* Including a hyphen in `how-to-guides` directory This removes any spaces from generated URLs for the pages contained therein, and is a bit more consistent with the existing directory structure. Signed-off-by: Elliot Voris <[email protected]> * Changing links `how-to guides` -> `how-to-guides` Signed-off-by: Elliot Voris <[email protected]> --------- Signed-off-by: Elliot Voris <[email protected]>
|
Preview is available here: |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We need to stage the release-related changes (such as auth next changes) in dev branch.