Partner Experience: Update Horizon documentation #249
Merged
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
Co-authored-by: shawn <[email protected]>
* Change TX_SUB_ENABLED to DISABLE_TX_SUB * Update docs/run-platform-server/configuring.mdx Co-authored-by: urvisavla <[email protected]> --------- Co-authored-by: urvisavla <[email protected]>
|
Preview is available here: |
|
Preview is available here: |
7 tasks
|
Preview is available here: |
|
Preview is available here: |
tamirms
reviewed
Nov 28, 2023
tamirms
reviewed
Nov 28, 2023
|
Preview is available here: |
|
Preview is available here: |
|
Preview is available here: |
|
Preview is available here: |
|
Preview is available here: |
|
Preview is available here: |
briwylde08
reviewed
Jan 17, 2024
|
Preview is available here: |
|
Preview is available here: |
|
Preview is available here: |
|
Preview is available here: |
|
Preview is available here: |
1 similar comment
|
Preview is available here: |
|
@briwylde08 , thanks for all your feedback, i think have caught up and addressed the, let me know how it looks? |
|
Preview is available here: |
|
Thank you! Looks better for sure. I still think the last couple of sections could use some love from a grammar perspective but I don't have time to go through it this week! I can always do it retroactively after merge though. |
|
Preview is available here: |
ElliotFriend
added a commit
that referenced
this pull request
Mar 25, 2024
…249) The previous image hash was used in these two tutorials, but is no longer working (I assume because there are no other nodes running that version). Here, both tutorials are updated to the latest preview version of the quickstart image. Signed-off-by: Elliot Voris <[email protected]> Signed-off-by: Elliot Voris <[email protected]>
ElliotFriend
added a commit
that referenced
this pull request
Mar 27, 2024
* Move Learn and Under-the-Hood to Guides (#39) * Changes from meeting today (#40) * Expand the create a project section (#41) * added category indexes * Add title of file to example (#42) * Update optimized page (#44) * Fix links (#45) * update first project to create a project * Change "their" to "there" Grammar. * Changed "environments" to "environment's" Grammar. * Facilities spelling error * Remove double "the" * Added apostrophe in "project's" for possession * Fix quick-start example (#53) * A few tweaks to quick start guide to make it work (#54) * fix cli usage (#55) * Update crate links to use crates.io (#56) * Merge the rustup sections (#57) * Fix cli version (#58) * Fix formatting (#59) * Variety of small fixes (#65) * Add warning for hyphenated project names (#67) * Correct few typos in examples and tutorials (#83) * Update sdk and cli versions and output (#87) * Update code samples in quickstart (#88) * empty * Update the tutorial for creating a project (#89) * Update the tutorial for writing a contract (#90) * Update the tutorial for testing (#91) * Put auth example earlier in list of examples (#96) * noop * noop * Update sdk and cli versions and output (#87) * Update code samples in quickstart (#88) * empty * Update the tutorial for creating a project (#89) * Update the tutorial for writing a contract (#90) * Update the tutorial for testing (#91) * Update the hello_world contract (#92) * Small fix to hello contract * Update the increment contract (#93) * Small fix to increment example * Update the custom_types contract (#94) * Add auth example and update auth learn page (#95) * Put auth example earlier in list of examples Co-authored-by: Tyler van der Hoeven <[email protected]> Co-authored-by: Siddharth Suresh <[email protected]> * Revert "Put auth example earlier in list of examples (#96)" (#97) This reverts commit 1dc54990726ce713b3e760fab62067bf687775e8. * Add auth sdk page (#108) * noop * noop * Update sdk and cli versions and output (#87) * Update code samples in quickstart (#88) * empty * Update the tutorial for creating a project (#89) * Update the tutorial for writing a contract (#90) * Update the tutorial for testing (#91) * Update the hello_world contract (#92) * Small fix to hello contract * Update the increment contract (#93) * Small fix to increment example * Update the custom_types contract (#94) * Add auth example and update auth learn page (#95) * Put auth example earlier in list of examples (#98) (cherry picked from commit fc2fc75d34aad6eecae9d5f8de10f16268edd7c2) * Add events example (#100) * Update the cross_contract contract (#99) * Small tweak to contract call doc * Fix to contract call code sample * Fix to contract call code sample * noop to try and make it deploy properly * Reorder examples so that contract events appears higher in list * Fix headings of cross contract example (#102) * Add soroban-cli read example * Tweak language about developer discord * Some changes to the events example page (#101) * Rename standard-contracts and update token-contract (#103) * Rename Standard Contracts to Built-In Contracts * Update built-in-contracts/token-contract and examples/authorization * Fix title capitalization of built-in contracts page (#104) * Add stub for token example (#105) * Update authorization docs to line up with contract examples (#106) * Small fixes for token contract doc * Make authorization docs line up with the example * Instruct users to checkout v0.0.4 tag for examples (#107) * fix pages and sdk instructions * Add auth sdk page Co-authored-by: Tyler van der Hoeven <[email protected]> Co-authored-by: Siddharth Suresh <[email protected]> Co-authored-by: Jay Geng <[email protected]> Co-authored-by: jonjove <[email protected]> * Revert "Add auth sdk page (#108)" (#109) This reverts commit ee9e03fbc565bec36f56ac811e65a851d4bf453b. * Add rust-src component install to build optimized tutorial (#117) * ran a linter on the docs * build optimized: fix admonitions (#118) * fix admonitions (#121) * Revert "fix admonitions (#121)" This reverts commit 59853b35d93fd25465c7ee95b9fcce44a36a076d. * Revert "build optimized: fix admonitions (#118)" This reverts commit 42f53d1133c3606cd3ef4f5446b7aafeb7c502b9. * Revert "ran a linter on the docs" This reverts commit c7984f63996fee7fab06fa97d5e31bc482b7b09c. * Rename soroban-cli to soroban * Add deployer example (#138) * Revert "Add deployer example (#138)" (#139) This reverts commit 2f4a60f24350dc2ea23f05f2ffc0c0d827a15987. * Add logging example (#148) * Update examples (#150) * Fix soroban-cli links (#152) * Fix soroban-cli links (#155) * Add `mod test;` to lib.rs and use `first_project` (#160) * Add run in pages (#179) * Tweaks to run on local network page * Move the FAQ to the top level (#182) * Add vscode links (#184) * Update versions of sdks and tools (#185) * Remove out-dated recommendation about testutils feature (#187) * Tweak recommendation * Add details about building with logs to project setup (#188) * Update the links for reporting issues (#189) * Move the optimized build instructions inside the build page to shorten the list of tutorials (#190) * Update soroban-cli version (#192) * Fix broken links (#195) * Fix a typo * Update for built-in token docs (#193) Co-authored-by: Leigh McCulloch <[email protected]> * Fix typo * Fix typos in command examples * Update soroban-cli to v0.1.2 (#196) * Tweaks to pages * Fixes to examples and docs (#199) * Move Build Optimized out of details section (#202) * fix broken link in setup.mdx (#204) Co-authored-by: Leigh McCulloch <[email protected]> * Make it clearer that optimization is unnecessary (#205) * Make it clearer that optimization is unnecessary * less words * Update build-optimized.mdx Co-authored-by: Tyler van der Hoeven <[email protected]> * Remove recommendation to use the rlib crate type (#212) * Remove recommendation to use the rlib crate type (#212) * Fix typo (#213) * Update Examples, SDK and CLI v0.2.1 * Pin docker image * Update Examples, SDK and CLI v0.2.1, and Quickstart Image (#221) * Fix typos (#222) * add quotes around curl argument (#224) needed for zsh and maybe some other shells * quote curl argument for zsh & maybe other shells (#226) * Update version of SDK (#236) * Remove BigInt and replace with i128 (#237) * Update soroban-cli to v0.3.1 (#239) * Next Release Dev Branch (#231) * add instructions on how to Sign Transactions with Freighter (#200) * Reorder the nav bar (#244) * Update Examples, SDK and CLI v0.2.1 * Pin docker image * Add release notes (#234) * Rename and move releases page * reorder EVERYTHING * reorder Learn between Examples and SDKs * update wallet position Co-authored-by: Leigh McCulloch <[email protected]> * Update soroban-{sdk, auth, example, cli} versions (#245) * added [package] entries (#248) allowing full 'Cargo.toml' code to be copied * Updating the futurenet and localnet tutorials with latest quickstart (#249) The previous image hash was used in these two tutorials, but is no longer working (I assume because there are no other nodes running that version). Here, both tutorials are updated to the latest preview version of the quickstart image. Signed-off-by: Elliot Voris <[email protected]> Signed-off-by: Elliot Voris <[email protected]> * Update Soroban transaction document. (#251) * Update outdated token terminology * Update various sdk, auth, examples versions from 0.3.2 to 0.4.2 * fix doc * fix doc (#268) * Support arm64 images in docs for quickstart (#274) * update all admonitions such that prettier doesn't yell * Lots of formatting * Reorg (#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 setup.mdx (#279) 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. * Including a hyphen in `how-to-guides` directory (#298) * 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]> * Update hello-world.mdx (#304) * update setup instructions. * Merge dev docs to main (#316) * proposed auth-next support for simulateTransaction method * Add note about multiple results * auth is an array * Updated example docs for Auth Next. (#306) * Updated example docs for Auth Next. * Update token documentation for Auth Next (#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 (#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 (#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 (#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. (#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]> * Use soroban-sdk the lasted version `0.6.0` in hello world example (#326) * Combine Hello World sections (#345) * Clean up page descriptions in category indexes (#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]> * Update symbol functions and some related docs. * bump examples to 0.7.0 * Update setup with 0.7.0 (#364) * Pin docker images to release version (#365) * Update the cli docs for preview 8 release (#371) * Update deploy-to-futurenet to use public rpc (#372) * Create Run an RPC Adding a new page for the RPC * Rename Run an RPC to run-rpc * Rename run-rpc to run-rpc.mdx * Update run-rpc.mdx * Update run-rpc.mdx * Update run-rpc.mdx * Update run-rpc.mdx * Update run-rpc.mdx * Update run-rpc.mdx * Update run-rpc.mdx * Update run-rpc.mdx * Update run-rpc.mdx * Update run-rpc.mdx * Update run-rpc.mdx * Update run-rpc.mdx * Update run-rpc.mdx * Update run-rpc.mdx * Update run-rpc.mdx * Update run-rpc.mdx * Update run-rpc.mdx * Update run-rpc.mdx * unbork docs (#377) * a Removed symbol from soroban-sdk imports (#380) * Fix rpc-url for Futurenet deployment (#383) * a Removed symbol from soroban-sdk imports * Fix the rpc-url for Futurenet deployment * Anup doc updates (#378) * Updates per Anup's instructions * 10 -> 32 characters * 10 -> 32 character limit * 10 -> 32 characters * A comes before B * Update docs/how-to-guides/cross-contract-call.mdx Co-authored-by: Elliot Voris <[email protected]> * changed wording --------- Co-authored-by: Elliot Voris <[email protected]> * Update run-rpc.mdx (#386) Added back section RPC providers list (w/ fixed typo for URL reference) * add Freighter instructions (#390) * edition version (#393) * fixes malformed hello world link (#412) * Release preview 9 (#447) * update target directories (#405) * Add some basic documentation on fees & limits. (#417) * Add code and contract metadata (#418) * Update alloc crate for SDK v0.8.4 (#420) * Update atomic swap example for SDK v0.8.4 (#421) * Update atomic swap example for SDK v0.8.4 (#422) * Update auth example for SDK v0.8.4 (#423) * Add note about contract meta to build-your-own-sdk page (#424) * Add note about contract meta to build-your-own-sdk page * add link * Update cross-contract example for SDK v0.8.4 (#425) * Update custom account example for SDK v0.8.4 (#426) * Update custom types example for SDK v0.8.4 (#427) * Update deployer example for SDK v0.8.4 (#428) * Update errors example for SDK v0.8.4 (#429) * Update events example for SDK v0.8.4 (#430) * Update liqpool example for SDK v0.8.4 (#431) * Update logging example for SDK v0.8.4 (#432) * Update single-offer-sale example for SDK v0.8.4 (#433) * Update stellar asset contract page for SDK v0.8.4 (#434) * Update timelock example for SDK v0.8.4 (#435) * Update token example for SDK v0.8.4 (#436) * Update contractmeta! page for SDK v0.8.4 (#437) * Update getting started setup page for SDK v0.8.4 (#438) * update soroban-cli and example versions (#441) * update soroban-cli and example versions * update token contract interface link * update-release-page (#446) * update-release-page * add changelog * Add explaination to metering (#443) --------- Co-authored-by: Dmytro Kozhevin <[email protected]> Co-authored-by: Siddharth Suresh <[email protected]> Co-authored-by: Leigh McCulloch <[email protected]> Co-authored-by: Jay Geng <[email protected]> * update quickstart hash (#456) * updates quickstart versions (#459) * Evm to Soroban (#409) * initial commit * add code breakdown * add mdx * remove mdx * update Rust SC * add advanced concepts * add vault contract and tests * Update solidity-and-rust-advanced-concepts.mdx * remove un tabbed code * update vault.rs; add shell cmds * update yield amount * add vault deployment and interaction * add wdraw message * fix script sequence * add EVM comparison * update error handling * 1st round review * Update script descroption * add solidity to approved languages * fixed a broken link * move file folder; add token inheritance * update links * fixed broken links * update Soroban Description * nit: spelling * Fix bytes and arrays * spelling errors * spelling errors * no capitalization on build * grammar spelling errors * spelling and grammar errors * fixes; post PR review * macros description * Correction: Data Types * update Symbol Definition * update traits definition: fix Solidity Contract * Merge main into evm-to-soroban (#414) * update code block (#400) * additional copy changes to site (#401) * copy edits from Dom (#403) * update broken link (#404) * update token interface (#406) * update token intereface Interface was referenced from : https://github.com/stellar/rs-soroban-sdk/blob/main/soroban-sdk/src/token.rs * update fn description * nit: update fn description * nit: format * nit: bracket format * fix event topics * update events * revert per PR to fix event name https://github.com/stellar/rs-soroban-env/pull/778/files * Improve Failure Condition Handling in Token Interface (#394) * Add Error Handling Section * update authorization info * add more context to authorization * nit: call not specific to callers address * Add event docs (#375) * Add event docs * Remove note * Add link to events example * fixes malformed hello world link (#412) * Remove derive Default (#413) --------- Co-authored-by: Tyler van der Hoeven <[email protected]> Co-authored-by: Bri <[email protected]> Co-authored-by: Siddharth Suresh <[email protected]> Co-authored-by: Leigh McCulloch <[email protected]> * fix spelling and add string example * move evm-to-soroban * resolve conflict * add auth section. Add comparison for addresses * embolden main point about replay prevention * nit update section * nit wording * improve Address and Auth Callouts * update contract deposit fn. Update ID to addr conversion * nit: var placeholders * example vault update * update vault example to 8.1 * update to align w main * updates Env:: to env. ; nits * add section on composability * nit: update soroban-sdk version * update example to use sdk 8.4 * remove admin from mint * nit: grammar; update tx messages --------- Co-authored-by: Tyler van der Hoeven <[email protected]> Co-authored-by: Bri <[email protected]> Co-authored-by: Siddharth Suresh <[email protected]> Co-authored-by: Leigh McCulloch <[email protected]> * copy edits (#467) * copy edits * Update connect-freighter-wallet.mdx * Update run-rpc.mdx * docs reorg 2.0 (#474) * docs reorg 2.0 * fixed links * Move invoking contracts with Stellar transactions (#488) * Update hello-world.mdx (#490) * Release Preview 10 (#480) * Change command recommended for building .wasm files for deployment (#476) * Fix logging example (#481) * Update docs with auth XDR changes. (#483) * Update docs with auth XDR changes. * WASM->Wasm rename. Wasm is the official abbreviation of WebAssembly. * Typo fixes (#484) * Add fuzzing docs. (#486) * State expiration operations and token updates (#485) * Add docs for state expiration operations * Updates * update token * Update custom account * More token updates * Update atomic swap * More detailed state expiration docs (#492) * More fixes (#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 (#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]> * Update setup.mdx (#495) * fix versions (#497) * add #[contract] and symbol_short (#498) * #[contract]; symbol_short description * Update hello-world.mdx * add missing symbol_short and #[contract] references * fix: move State Expiration to Concepts (#505) This is not part of the core onboarding tutorial. It probably belongs in Fundamentals and Concepts instead. For background, these docs are attempting to use [Divio's documentation system](https://documentation.divio.com/), with the "Getting Started" section as _The_ Tutorial. The "Fundamentals and Concepts" section is what Divio describes as "Explanation" docs. * fix: move RPC doc out of Getting Started (#504) This seems like part of the RPC reference material, not an essential thing that someone needs to know as part of the "official onboarding tutorial," which is what Getting Started is supposed to be. * Format (#508) * package updates * cleaned up formatting * add initial gh action (#507) * add initial gh action * fix links --------- Co-authored-by: Bri <[email protected]> * Clean up Getting Started tutorial; add "Deploy to Futurenet" (#516) * feat: move Freighter and Running RPC to Reference We want to keep the stuff in Getting Started hyper-focused on a quick end-to-end tour of Soroban. Now that there's a public RPC endpoint, it is much more straightforward to have people deploy contract right to it, rather than running their own nodes. Running your own node is a more advanced concept that dabblers need not muck with. So this moves both the "Deploy to a Local Network" and "Deploy to Futurenet" pages to the RPC page, in the Reference section. This required some reorganization & rework of the concepts to make it fit the new context. I also updated some instructions, such as teaching people to use `soroban config network` and `soroban config identity`, which were not included in the old "Deploy to…" pages. This commit also moves the "Connect Freighter Wallet" to Reference, since it's a bit in-the-weeds, which is a good feature for a Reference document but not for an end-to-end Tutorial. Coming Soon™: a new "Deploy Contracts" step in the Getting Started section, which uses the public RPC Futurenet endpoint. This will be followed by a "Create a Dapp" step, which will use the new JS Lib generation built into the CLI, and go over relevant Freighter details. * fix: clean up Hello World walk-through - explicitly instruct people to call it `hello-soroban` - move some single-use footnote-style links inline, to make them easier to see/understand/update later - remove spacing around tips for easier visual parsing - remove "Hello World Example" section, since this IS the Hello World example - remove unused & unneeded footnote-style link definitions - clean up example code so it doesn't give warnings on copy/paste * feat(getting-started): clean up Storing Data I'm working toward having people create a frontend Dapp with multiple contracts in a `contracts` folder, so I added a whole part at the beginning walking people through setting up a Cargo Workspace. This page also had more information than necessary about State Expiration; I moved this to the State Expiration doc, which had been practically blank. I reorganized this information somewhat; most notably, the "Best Practices" section had been practically empty. I moved some miscellaneous information to it; it should maybe be renamed "more information about state expiration" rather than "best practices", since it DOESN'T currently contain best practices, and I am not qualified to say what Best Practices might actually be. (Note that in the old version, the "Best Practices" section was blank! It was a misplaced heading, with nothing relevant below.) * fix: add missing "be" Co-authored-by: Willem Wyndham <[email protected]> * feat: add 3. Deploy to Futurenet This contains the relevant details people will probably need to know when first getting started with Soroban. * fix: run prettier * feat: commit, summarize, save IDs to files Instructing people to commit to git will help them think about their work more clearly, and will also help them avoid mistakes and get better help when they need it. I also added summaries to each of these tutorial pages, to review what was learned and set up the next lesson. Finally, I decided to have them save contract IDs to files in their `.soroban` folder, rather than in more-ephemeral environment variables. This will make it easier to have them use `soroban contract bindings` in the "Build a Dapp" step, since they'll be able to reference these files in their package.json scripts. * fix: run lint --------- Co-authored-by: Willem Wyndham <[email protected]> * Clean up Getting Started tutorial; add "Deploy to Futurenet" (#516) * feat: move Freighter and Running RPC to Reference We want to keep the stuff in Getting Started hyper-focused on a quick end-to-end tour of Soroban. Now that there's a public RPC endpoint, it is much more straightforward to have people deploy contract right to it, rather than running their own nodes. Running your own node is a more advanced concept that dabblers need not muck with. So this moves both the "Deploy to a Local Network" and "Deploy to Futurenet" pages to the RPC page, in the Reference section. This required some reorganization & rework of the concepts to make it fit the new context. I also updated some instructions, such as teaching people to use `soroban config network` and `soroban config identity`, which were not included in the old "Deploy to…" pages. This commit also moves the "Connect Freighter Wallet" to Reference, since it's a bit in-the-weeds, which is a good feature for a Reference document but not for an end-to-end Tutorial. Coming Soon™: a new "Deploy Contracts" step in the Getting Started section, which uses the public RPC Futurenet endpoint. This will be followed by a "Create a Dapp" step, which will use the new JS Lib generation built into the CLI, and go over relevant Freighter details. * fix: clean up Hello World walk-through - explicitly instruct people to call it `hello-soroban` - move some single-use footnote-style links inline, to make them easier to see/understand/update later - remove spacing around tips for easier visual parsing - remove "Hello World Example" section, since this IS the Hello World example - remove unused & unneeded footnote-style link definitions - clean up example code so it doesn't give warnings on copy/paste * feat(getting-started): clean up Storing Data I'm working toward having people create a frontend Dapp with multiple contracts in a `contracts` folder, so I added a whole part at the beginning walking people through setting up a Cargo Workspace. This page also had more information than necessary about State Expiration; I moved this to the State Expiration doc, which had been practically blank. I reorganized this information somewhat; most notably, the "Best Practices" section had been practically empty. I moved some miscellaneous information to it; it should maybe be renamed "more information about state expiration" rather than "best practices", since it DOESN'T currently contain best practices, and I am not qualified to say what Best Practices might actually be. (Note that in the old version, the "Best Practices" section was blank! It was a misplaced heading, with nothing relevant below.) * fix: add missing "be" Co-authored-by: Willem Wyndham <[email protected]> * feat: add 3. Deploy to Futurenet This contains the relevant details people will probably need to know when first getting started with Soroban. * fix: run prettier * feat: commit, summarize, save IDs to files Instructing people to commit to git will help them think about their work more clearly, and will also help them avoid mistakes and get better help when they need it. I also added summaries to each of these tutorial pages, to review what was learned and set up the next lesson. Finally, I decided to have them save contract IDs to files in their `.soroban` folder, rather than in more-ephemeral environment variables. This will make it easier to have them use `soroban contract bindings` in the "Build a Dapp" step, since they'll be able to reference these files in their package.json scripts. * fix: run lint --------- Co-authored-by: Willem Wyndham <[email protected]> * Updating `soroban-cli` version and adding bash completion note (#527) * Updating `soroban-cli` version and adding bash completion note * Adding example commands to enable autocompletion * update SEO titles and descriptions (#534) * update SEO titles in Getting Started * Update setup.mdx * SEO titles and descriptions in Getting Started * formatting * update titles and descriptions for basic tutorials * update SEO in advanced tutorials * updated header for SEO * fix * updating... again! * feat: add "4. Build an App" step to "Getting Started" (#528) Uses smartdeploy CLI branch for now, for futurenet compatibility Co-authored-by: Julian Martinez <[email protected]> Co-authored-by: tomerweller <[email protected]> Co-authored-by: Bri Wylde <[email protected]> Co-authored-by: Tyler van der Hoeven <[email protected]> * Update soroban versions to 20.0.0-rc2 (#574) * update soroban versions * update docs to use rc2 * More updates to old CLI versions (#575) * docs: fixing a link to create a new issue for Soroban CLI * docs: Updating the `soroban` usage for `v20.0.0-rc2` * docs: updating link to auto-generated cli docs * docs: Updating tutorials to point to `v20` tag of the examples repo * docs: Updating "migrating from evm" article to use `v20.0.0-rc2` examples * docs: changing to `v20.0.0-rc2` examples repo in getting started section * Update Futurenet to Testnet Across Documentation (#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 (#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 helloworld to use `project_name` in line with Rust compilation behavior (#588) Signed-off-by: sonichen <[email protected]> * update release versions and add new Freighter setup directions (#589) * update release versions and add new Freighter setup directions * reformat Freighter docs * re-adding swap dapp * adds docs for Freighters signAuthEntry API (#592) * adds docs for Freighters signAuthEntry API * format new docs * Update docs/reference/freighter.mdx Co-authored-by: Elliot Voris <[email protected]> --------- Co-authored-by: Elliot Voris <[email protected]> * docs: update sdk version to 20.0.0-rc2 (#601) * Create rpc-list.mdx (#606) * Create rpc-list.mdx Adding draft directory page * Update rpc-list.mdx updated * Update rpc-list.mdx Updated section * Update rpc-list.mdx Removed comments * fix markdown formatting in rpc provider table * add front-matter to rpc-list document, and small wording nits * Re-titling RPC -> RPC Usage * Adjust some wording surrounding ecosystem RPC providers * add description about what services SDF provides * style: cleanup some markdown formatting and remove a redundant line --------- Co-authored-by: Elliot Voris <[email protected]> * docs: explain the diagnostic events that are emitted in sandbox (#593) * docs: explain the diagnostic events that are emitted in sandbox Perhaps this approach is too verbose? I think having the explanation of what is being seen right there in the tutorial is useful at this early step in the "getting started" section. A new developer is more likely to understand what they see, and remember what it is in the future if we don't try to interrupt their flow at this point by sending them to another page for some (possibly irrelevant) info. I may be incorrect there, and I'm happy to hear opinions from others. Refs: #521 * docs: add a space between two words * editorial in Update hello-world.mdx --------- Co-authored-by: Bri Wylde <[email protected]> * Update getting-started for 20.0.0-rc.4.1 cli (#636) * Updates to setup.mdx * Add CLI for testnet configuration to Setup * Updates to hello-world.mdx Reorder some code snippets to be after the description * Small edits in storing-data.mdx * Add high_expiration_watermark argument to bump in incrementor * Move deploy-to-testnet after hello-world to allow the user to interact with their contract on testnet * Add Optimizing Builds to hello-world * Update storing-data to remove sandbox interation * Add a deploy-incrementor-to-testnet step * Update position of Create an App * Apply suggestions from code review Co-authored-by: Chad Ostrowski <[email protected]> * Apply suggestions from code review Co-authored-by: Chad Ostrowski <[email protected]> * Update create-an-app.mdx * Fix typo * Add a mv command for .soroban dir when reorganizing to a multi-contract project * Apply mdx prettier updates * Update astro port in create-an-app.mdx * Apply suggestions from code review Co-authored-by: Elliot Voris <[email protected]> * Add .mdx to end of internal markdown links for docusaurus magic * Make sure there are new lines before and after ::: tags * Some additional edits/improvements * Mention that Freighter is available as a firefox add-on * Update the deploy-incrementor url * Apply prettier updates --------- Co-authored-by: Chad Ostrowski <[email protected]> Co-authored-by: Elliot Voris <[email protected]> * docs: move data providers page out of sdks directory (#645) * Update getting started tutorial to use an Astro template (#642) * Update create-an-app.mdx to use an Astro template * Apply prettier formatting * Add some additional gotchas to the troubleshooting section * Reworks hello-world.mdx using the Astro template * Rework deploy-to-testnet.mdx to interact with the contarct via the frontend * Update storing-data.mdx * Update deploy-incrementor.mdx * Change create-an-app.mdx to wrapping-up.mdx * Apply prettier updates * Apply suggestions from code review Co-authored-by: Chad Ostrowski <[email protected]> * Address PR feedback - move "???" bummer to "taking it further" - add command expansion note to deploy-to-testnet - remove mention of incrementor in deploy-to-testnet * Small cleanup * Address PR feedback * Remove release-with-logs section * Update code snippets to match updated tutorial code * Apply suggestions from code review Co-authored-by: Elliot Voris <[email protected]> * Address PR feedback * Check in prettier updates * update getting started links on the landing page * redirect the old create an app page to the hello world page --------- Co-authored-by: Chad Ostrowski <[email protected]> Co-authored-by: Elliot Voris <[email protected]> Co-authored-by: Elliot Voris <[email protected]> * build: a couple small fixes to get the build to work (#657) * build: a couple small fixes to get the build to work * style: changing the way a couple codefences work * Revert "Update getting started tutorial to use an Astro template (#642)" (#658) This reverts commit fb7ecc0db4f90fdb9ab5586f1bd0565c1ca994a2. * Remove step adding target dir to gitignore (#660) * Update soroban-sdk to v20.0.0-rc2.2 (#667) * Remove git init from hello world steps (#666) * Remove some outdated cautions from the docs, now that Soroban should be stable. (#672) * State archival refactor (#678) * State archival refactor * Small fixes * Remove cache `gitignore` from hello-world.mdx (#674) * Remove cache `gitignore` from hello-world.mdx Current `soroban` version doesn't cache files in the project dir. * Retry helping with the confusion * Update docs/getting-started/hello-world.mdx Co-authored-by: Elliot Voris <[email protected]> --------- Co-authored-by: Elliot Voris <[email protected]> * Add v20.0.0 (#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 (#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]> * remove rc2 references (#685) * Update soroban-cli version in Setup, and other pages. #693 (#694) * Documentation Mismatch for Logging after SorobanSDK Update #615 * soroban-docs: Update soroban-cli version to 20.1.0 and change auto generated links (#693) * Update JavaScript SDK references to use the `@stellar/stellar-sdk` package (#687) * Upgrade js sdk dependencies to latest * Track down references to soroban-client and move them * Ran linter * Getting started: update CLI version (#697) * Add SDK examples alongside XDR structure explanations (#699) * Pre mainnet restructure (#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 (#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 (#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 * Update maximum contract size limit in the `Getting Started` tutorial (#705) * Refactor wrap/deploy of SAC (#718) Co-authored-by: Leigh McCulloch <[email protected]> Co-authored-by: Elliot Voris <[email protected]> * Refactor deprecated calls to `soroban config` (#731) * [Do Not Merge] Updates pending vote (#729) * update to the welcome page to reflect the live on Mainnet status * remove note about non-production software on networks page * add the link definition for the phased rollout * [Stellar Merge] Tools Section (#739) * create redirects for tools and SDKs pages * adjust some redirect URLs to better reflect new stellar-docs pages * forgot a semicolon! * linking to migrated developer tools page * fine-tuning some redirects * add a list of "already migrated" stuff to the sidebar * remove SDKs content that's being migrated * fix the resulting broken links * Revert "remove SDKs content that's being migrated" This reverts commit 6dd2a28a8f124e876607a9bf30894a420ea6eb08. * Revert "linking to migrated developer tools page" This reverts commit fc2340818a08c42fc1f13f6a49d97111610c9100. * try this method of turning docs into external links * include soroban-cli page in the tools migration * change cli links to developer docs * use by-name params in pagination example (#743) Refs: #728 * Update the community RPC list (#744) * Update RPC list with network info * Add run your own RPC * Fix urls for soroban cli * Fix path to cli * Fix relative link * Add formatted mdx --------- Co-authored-by: Jane Wang <[email protected]> * update soroban-cli version in getting started: 20.3.0 (#749) * Update soroban cli version to the latest (#755) Co-authored-by: Jane Wang <[email protected]> * Remove version from soroban-cli install instruction (#758) * Update outdated code. (#759) * Use `soroban contract init` command in getting started tutorial (#730) * Updates to setup.mdx * Rework hello-world to use the soroban contract init command * Rework deploy-to-testnet.mdx to use init command * Rework storing-data.mdx * Rework storing-data.mdx * Rework deploy-increment-contract.mdx * Rework create-an-app * Udpate deploy increment file name * Apply suggestions from code review Co-authored-by: Elliot Voris <[email protected]> * Update re-installing to enable opt to not include version Co-authored-by: Elliot Voris <[email protected]> * Update docs/getting-started/setup.mdx Co-authored-by: Elliot Voris <[email protected]> * Address PR feedback * Simplfy generate and fund command calls * Update .env.example code block to match the fe template * Small updates toe create-an-app.mdx --------- Co-authored-by: Elliot Voris <[email protected]> * Update errors example to use the latest cli. (#768) Co-authored-by: Elliot Voris <[email protected]> * Clean up the stellar asset contract overview (#771) Co-authored-by: Elliot Voris <[email protected]> * move content into "smart-contracts" directory * initial import of "Smart Contracts" section content * first batch of fixed links * fix some more broken links * format and lint markdown * display DocCards on all "Guides" pages * change "tutorials" to "example contracts" * fix some "tutorials" -> "example-contracts" broken links * use README.mdx files in smart contracts section * break "freighter" page into a few different guides * change a link to a freighter guide * markdown linting * fix a broken link * change a freighter link * remove unnecessary (and wrong) canonical url meta tags * simplify the hidden "guides" and "example contracts" stuff! * move FAQ from "smart contracts" into "learn" sub-section * get rid of the old soroban "welcome" page * update links and pull in latest changes from soroban repo Co-authored-by: Siddharth Suresh <[email protected]> * back n forth between issue assets n SAC * adding a couple build app notifications * add meaningful sidebar positions to the example contract pages Refs: stellar/soroban-docs#717 * replace "tutorial" verbiage with "examples" and such * add badges to denote level to example contracts * let's do…
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
These changes are related to partner experience initiatives, to consolidate and streamline horizon docs, update/refactor the copy to be lighter, concise, and provide more directed, opinionated recommendations towards expected outcomes on installations and configuration.
Closes #243
list of sub-tasks and associated pull requests on docs which have been completed by the team and gone through internal review, consolidated into this final change set:
https://github.com/stellar/stellar-docs/issues?q=is%3Aissue+label%3Apartner-experience
associated changes completed in the Horizon source code repo, which were done in tandem and referenced by docs: