SDP: update user guide #197
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
|
Preview is available here: |
|
Preview is available here: |
|
Preview is available here: |
|
Preview is available here: |
|
Preview is available here: |
|
Preview is available here: |
|
Preview is available here: |
reecexlm
approved these changes
Jul 26, 2023
torisamples
approved these changes
Jul 26, 2023
ElliotFriend
pushed a commit
that referenced
this pull request
Mar 6, 2024
* permit homepage * progress * desktop version is donenough * slight mobile tweaks * feedback tweaks * small order and style tweaks * mobile tweaks * copy tweak * moar slight tweaks * add Sorobanathon links * slight rename * z-index tweaks * USDC -> XLM * copy tweak * tweakers for weekers * copy and zindex tweaks * appeasing the nit pickers
ElliotFriend
added a commit
that referenced
this pull request
Mar 13, 2024
* initial commit * example including an image * add doc on assets-and-authorization, with auth part filled in * update wordmark * Add a homepage (#197) * permit homepage * progress * desktop version is donenough * slight mobile tweaks * feedback tweaks * small order and style tweaks * mobile tweaks * copy tweak * moar slight tweaks * add Sorobanathon links * slight rename * z-index tweaks * USDC -> XLM * copy tweak * tweakers for weekers * copy and zindex tweaks * appeasing the nit pickers * added a meta image * Soroban landing (#396) * init soroban landing * Start landing markup * Add earn section and refine styles * Add SCF section * Add Soroban section * Update hero min-height * add media section * add assets v1 * add links to getting started * update twitter * add assets v2 * add missing links * Adjust images * final * clean up old home page assets * cleanup scss colors * added hello world code * dark mode * fixed some minor issues * updaters * add a 5. card --------- Co-authored-by: Jesmar Castillo <[email protected]> Co-authored-by: Tyler van der Hoeven <[email protected]> * 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]> * Add dapps challenge (#487) * Add Dapps Challenge to Docs Todo: user dashboard visibility * add hide unless dapps * update user card * update checkpoints * add user dashboard to dapps challenges * Update Dapp Challenge Description * Update tsconfig.json * fix tsconfig.json * small grammar fixes * small grammar fixes * small grammar fixes * small grammar fixes * small grammar fixes * update challenge 0 and 1 ; add images for challenge 2 * Capitalize Futurenet; lowercase Dapp when needed * disclaimer; nit crowdfunding -> crowdfund * Update challenge-0-crowdfund.mdx * update layout and guides * Update smart-contracts.mdx * update content * add links * nit update soroban quickstart * Update react.mdx * Update challenge-0-crowdfund.mdx * update start course redirect * we -> you * update wrangler endpoint to stellar cloudflare * update wrangler endpoint * add module resolution and jsx * add wrong network page; remove unused code; add vercel.app checking * update wallets conclusion * nit Update wallets.mdx * nit update broken link * Freighter -> WalletData Component * update crowdfund dapps challenge for P10 * Fix Setup * update docker workflow; add better notes * nit standalone docker requirement * re-enable .vercel.app check; move ParentChallengeForm * move Login function * fixed automatic log in problem * comment out connection check * comment out auto connect hook; nit Login -> Connect * removed unused setLoading() changed order of operations * update to checkout challenge branch * completed challenge message = clickable url * remember user is logged in * setup `BrowserOnly` * Update yarn.lock * Update yarn.lock * merge main into dapps challenge * Update yarn.lock * nit: refresh message * add disconnect button comment; better connection insight * update contract initialization to use strings * auto populate url; add resubmit; fix broken invoke * add setSavedUrl; improve url auto populate * improve local storage for pubkey --------- Co-authored-by: Bri <[email protected]> * seo-editorial-docs (#547) * SDC UI upgrades (#542) * Update index.tsx * update kv:worker endpoint * Update index.tsx * Add Root component, finish-step-button, update styles * Add library for toast notifications, show milestone notification * Add class for HttpClient, functions for requests * Changed backend model, finalize user progress on course * Add confetti effect on complete button click, refactor * Remove mocks, use endpoint, fix issues * Merge Development into main (#2) * update kv:worker endpoint * Update index.tsx * Add Root component, finish-step-button, update styles * Add library for toast notifications, show milestone notification * Add class for HttpClient, functions for requests * Changed backend model, finalize user progress on course * Add confetti effect on complete button click, refactor * Remove mocks, use endpoint, fix issues --------- Co-authored-by: Iryna Telesheva <[email protected]> Co-authored-by: Iryna Telesheva <[email protected]> * Add Dashboard for Dapps challenges (#3) * Added dashboard component, styled cards * Added DashboardHeader, Leaderboard component, tabs, styles * Added ChallengesList component, updated login logic, tabs * Refactor existing approach, update models, add filtering * Add UI folder, add id for switcher and random avatar generating * Remove old dashboard components, rename util file * Add dashboard link to dapps sidebar instead of navbar * Add TODOs, rename component * Fix issues * Add Dashboard for Dapps challenges (#3) (#4) * Added dashboard component, styled cards * Added DashboardHeader, Leaderboard component, tabs, styles * Added ChallengesList component, updated login logic, tabs * Refactor existing approach, update models, add filtering * Add UI folder, add id for switcher and random avatar generating * Remove old dashboard components, rename util file * Add dashboard link to dapps sidebar instead of navbar * Add TODOs, rename component * Fix issues Co-authored-by: Iryna Telesheva <[email protected]> * Merge SDC from julian-dev28:main to Stellar:SSDC23 (#541) * Update index.tsx * update kv:worker endpoint * Update index.tsx * Add Root component, finish-step-button, update styles * Add library for toast notifications, show milestone notification * Add class for HttpClient, functions for requests * Changed backend model, finalize user progress on course * Add confetti effect on complete button click, refactor * Remove mocks, use endpoint, fix issues * Merge Development into main (#2) * update kv:worker endpoint * Update index.tsx * Add Root component, finish-step-button, update styles * Add library for toast notifications, show milestone notification * Add class for HttpClient, functions for requests * Changed backend model, finalize user progress on course * Add confetti effect on complete button click, refactor * Remove mocks, use endpoint, fix issues --------- Co-authored-by: Iryna Telesheva <[email protected]> Co-authored-by: Iryna Telesheva <[email protected]> * Add Dashboard for Dapps challenges (#3) (#4) * Added dashboard component, styled cards * Added DashboardHeader, Leaderboard component, tabs, styles * Added ChallengesList component, updated login logic, tabs * Refactor existing approach, update models, add filtering * Add UI folder, add id for switcher and random avatar generating * Remove old dashboard components, rename util file * Add dashboard link to dapps sidebar instead of navbar * Add TODOs, rename component * Fix issues Co-authored-by: Iryna Telesheva <[email protected]> --------- Co-authored-by: Iryna Telesheva <[email protected]> Co-authored-by: Iryna Telesheva <[email protected]> * Update the user workflow for the challenges with CI/CD (#5) * Update the Crowdfund challenge with pull request validation step info * Refactor * Add isPullRequestRequired field handling * Update text for Crowdfund checkpoint 8 * Make isPullRequestRequired required * Fix issue with dates * Merge branch 'main' into SSDC23 * Update challenge-0-crowdfund.mdx --------- Co-authored-by: Iryna Telesheva <[email protected]> Co-authored-by: Iryna Telesheva <[email protected]> * Add lp dapp challenge (#543) * Create challenge-2-liquidity-pool * update lp dapp challenge * complete lp-dapp challenge * nit spelling * Update challenge-2-liquidity-pool.mdx * nit spelling * nit add steps to workflow * nit update workflow * update workflow again * add diff * edit diff * more diff editing * editorial edits * Update dapps/dapp-challenges/challenge-2-liquidity-pool.mdx Co-authored-by: Elliot Voris <[email protected]> * Update dapps/dapp-challenges/challenge-2-liquidity-pool.mdx Co-authored-by: Elliot Voris <[email protected]> * Update dapps/dapp-challenges/challenge-2-liquidity-pool.mdx Co-authored-by: Elliot Voris <[email protected]> * Update dapps/dapp-challenges/challenge-2-liquidity-pool.mdx Co-authored-by: Elliot Voris <[email protected]> * Update dapps/dapp-challenges/challenge-2-liquidity-pool.mdx Co-authored-by: Elliot Voris <[email protected]> * add reference to earlier step; fix conflict in crowdfund dapp page * update quickstart version * small wording change --------- Co-authored-by: Bri Wylde <[email protected]> Co-authored-by: Elliot Voris <[email protected]> * Sdc mental models: payment dapp upgrades (#641) * bringing sdc-mental-models branch up to date (#632) * feat: provide a means of receiving simple feedback from users (#587) * feat: provide a means of receiving simple feedback from users Here, we have swizzled (ejected) the `DocItem/Footer` component from docusaurus, and are inserting our own `ReaderFeedback` component into it before the rest of the doc footer content. Also, the `custom.scss` file has been used to style this element in a consistent manner with the rest of the site. This is the first step to resolve #586: The user interaction can now take place. From here, we will work on integrating the custom events into Google analytics. Ultimately, we will like to implment this feature into the `stellar-docs` repository, as well. Refs: #586 * Moving some React state things around * Including an `alt` tag for the like/dislike buttons * use the `pageId` for `eventLabel` in the send event * style: Linting the code * style: changing inline svg tag to be on newlines, changine filename to `jsx` * feat: Inserting the `DocItem/Footer` components on `dapps` and `api` pages * feat: migrating to the GA4 plugin in docusaurus * Testing with a new ga4 tracking id for preview domain * add some console statements to test what's happening * add configuration for test gtag container for this pr preview * feat: use `gtag` over the deprecated `ga` function * adding my own test gtag? * Remove the `gtag` function call, and just register state * removing the old-style google analytics tag for good * remove staging tag manager containers in preparation for production * replace staging ga4 tracking id with production tracking id * use `@site/static` for feedback button imports, rename file extension * rpc: rename expirationLedgerSeq to liveUntilLedgerSeq (#625) * rpc: rename expirationLedgerSeq to liveUntilLedgerSeq * rpc: rename expiration ledger in openrpc file --------- Co-authored-by: Elliot Voris <[email protected]> * Remove docker image hashes (#628) * remove mentions of specific image hashes in docker commands * update docker image hash to most recent version on releases page * Update WASM retrieval tutorial (#627) * 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]> * Fix a couple typos in rust-dialect.mdx (#630) --------- Co-authored-by: Elliot Voris <[email protected]> Co-authored-by: Alfonso Acosta <[email protected]> Co-authored-by: George <[email protected]> Co-authored-by: Bri Wylde <[email protected]> Co-authored-by: Sapo-Dorado <[email protected]> * Crowdfund dapp copy updates v1 Added in some (minimal) context throughout. Tidied up a few grammatical/spelling inconsistencies. * add description and update "ship it" workflow * update soroban-cli install * Update challenge-0-crowdfund.mdx * remove extra vercel link * Merge branch 'main' into sdc-mental-models * Add intro to dapps * nit formatting * Payment dapp copy updates Updates to Checkpoints 0-4 of the Payment dapp challenge, including added copy and a few very minor grammatical upgrades. * add more context * Merge Payment dapp fix (#643) * Update latest testnet-compatible JavaScript release versions (#634) * Update latest testnet-compatible JavaScript release versions * Add links to release notes for each version * Upgrade `getLedgerEntries` examples to latest pre-stable releases of the SDKs (#635) Co-authored-by: Elliot Voris <[email protected]> * Switch Ubuntu base image to 22.04 from 20.04 (#638) Signed-off-by: Satyam Zode <[email protected]> Co-authored-by: Satyam Zode <[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: change preflight wording to simulate transaction (#585) * docs: change preflight wording to simulate transaction A first attempt to resolve #478, there may be more work to be done. I've used a few different phrases, depending on how the sentence structure works, perhaps taking some liberties in the process. I've also left alone the `releases` page for preview releases older than 11. It seems unnecessary to rewrite the development history too far into the past. Refs: #478 * editorial on Update interacting-with-contracts.mdx * added a couple "the"s Update state-expiration.mdx * fix wording about ledger entries to be less confusing * clearing up some other language surrounding footprints --------- Co-authored-by: Bri Wylde <[email protected]> * Create data-providers.mdx (#629) * Create data-providers.mdx Adding new page for data providers to cover indexers and block explorers * Update data-providers.mdx updated explanation text * style: fixing some markdown styles and formatting * Adding some more verbose descriptions and links --------- Co-authored-by: Elliot Voris <[email protected]> * docs: change sitewide wording from "preview release" to "release candidate" (#639) * docs: update welcome page "preview release" > "release candidate" * docs: change "preview release" > "release candidate" on releases page * update payment challenge; add styles * add clickable object to localhost:9000 example * Update challenge-1-payment.mdx * Squashed commit of the following: commit b6a1a46df7d2b42b340f1331ec52733bc6216725 Author: Julian Martinez <[email protected]> Date: Wed Nov 8 10:10:12 2023 -0800 add more context --------- Signed-off-by: Satyam Zode <[email protected]> Co-authored-by: George <[email protected]> Co-authored-by: Elliot Voris <[email protected]> Co-authored-by: Satyam Zode <[email protected]> Co-authored-by: Satyam Zode <[email protected]> Co-authored-by: Elizabeth <[email protected]> Co-authored-by: Chad Ostrowski <[email protected]> Co-authored-by: Elliot Voris <[email protected]> Co-authored-by: Bri Wylde <[email protected]> Co-authored-by: jcx120 <[email protected]> * format image * Squashed commit of the following: commit 308444d93d4f7133107ca499a6d255fe5ae302d4 Author: Julian Martinez <[email protected]> Date: Wed Nov 8 14:55:06 2023 -0800 update copy commit ec062702a5a900ff890bf5cc99dfd9b6dbe1915a Author: Julian Martinez <[email protected]> Date: Wed Nov 8 12:34:07 2023 -0800 add styles for lp commit f7bbf2e61a262aa6dd76bed2f43cd26aafce075b Author: Julian Martinez <[email protected]> Date: Wed Nov 8 12:13:49 2023 -0800 add image styles * update copy for production deployment * caution -> tip * add commas, add soroban-cli install to payment dapp * fix broken link * Squashed commit of the following: commit 7de8a99ec32065376ea4fd2f42a14194cdda6e49 Author: Elliot Voris <[email protected]> Date: Thu Nov 9 15:47:49 2023 -0600 docs: move data providers page out of sdks directory (#645) commit 55e0a866c6dbbe2b4dd38f38816915d59c962584 Author: Elliot Voris <[email protected]> Date: Tue Nov 7 11:40:20 2023 -0600 docs: change sitewide wording from "preview release" to "release candidate" (#639) * docs: update welcome page "preview release" > "release candidate" * docs: change "preview release" > "release candidate" on releases page commit 2ae107280eb4bfee7192e7bdabf704c80ffab43c Author: jcx120 <[email protected]> Date: Tue Nov 7 08:48:50 2023 -0800 Create data-providers.mdx (#629) * Create data-providers.mdx Adding new page for data providers to cover indexers and block explorers * Update data-providers.mdx updated explanation text * style: fixing some markdown styles and formatting * Adding some more verbose descriptions and links --------- Co-authored-by: Elliot Voris <[email protected]> commit 0054011876a8273788a5bf6de16623683c9159d2 Author: Elliot Voris <[email protected]> Date: Mon Nov 6 11:00:02 2023 -0600 docs: change preflight wording to simulate transaction (#585) * docs: change preflight wording to simulate transaction A first attempt to resolve #478, there may be more work to be done. I've used a few different phrases, depending on how the sentence structure works, perhaps taking some liberties in the process. I've also left alone the `releases` page for preview releases older than 11. It seems unnecessary to rewrite the development history too far into the past. Refs: #478 * editorial on Update interacting-with-contracts.mdx * added a couple "the"s Update state-expiration.mdx * fix wording about ledger entries to be less confusing * clearing up some other language surrounding footprints --------- Co-authored-by: Bri Wylde <[email protected]> commit b9710ea0ea6c4652aea2019504534197195a2b3a Author: Elizabeth <[email protected]> Date: Mon Nov 6 11:59:21 2023 -0500 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]> commit 61054dcad82dbf77c28aa1819ad08b6fa132ad70 Author: Satyam Zode <[email protected]> Date: Fri Nov 3 20:26:27 2023 +0530 Switch Ubuntu base image to 22.04 from 20.04 (#638) Signed-off-by: Satyam Zode <[email protected]> Co-authored-by: Satyam Zode <[email protected]> commit d6091131996ab81e42dff57f4bccaad3f5d56b3e Author: George <[email protected]> Date: Thu Nov 2 12:53:52 2023 -0700 Upgrade `getLedgerEntries` examples to latest pre-stable releases of the SDKs (#635) Co-authored-by: Elliot Voris <[email protected]> commit 228e4bfed691effa58a07b664abfd78b04e6dcd4 Author: George <[email protected]> Date: Thu Nov 2 09:18:50 2023 -0700 Update latest testnet-compatible JavaScript release versions (#634) * Update latest testnet-compatible JavaScript release versions * Add links to release notes for each version * add SEO logic --------- Signed-off-by: Satyam Zode <[email protected]> Co-authored-by: Elliot Voris <[email protected]> Co-authored-by: Alfonso Acosta <[email protected]> Co-authored-by: George <[email protected]> Co-authored-by: Bri Wylde <[email protected]> Co-authored-by: Sapo-Dorado <[email protected]> Co-authored-by: Julian Martinez <[email protected]> Co-authored-by: Julian Martinez <[email protected]> Co-authored-by: Satyam Zode <[email protected]> Co-authored-by: Satyam Zode <[email protected]> Co-authored-by: Elizabeth <[email protected]> Co-authored-by: Chad Ostrowski <[email protected]> Co-authored-by: Elliot Voris <[email protected]> Co-authored-by: jcx120 <[email protected]> * undo some changes from the docs scavenger hunt (#656) * clearer Soroban favicon (#662) * Add oracle dapp challenge (#664) * add oracle dapp * update endpoint * add images * Update http-client.ts * update challenge list * add last checkpoint to oracle dapp * Update http-client.ts * update meta tag * add some items for the rollout (#684) * 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 * docs: make the transaction lifecycle page a draft (#701) * Fix description of enums supported by contract types (#703) * Update resource limits and make a new reference page for them (#736) * add a reference page on resource limits and fees * remove resource fee/limit tables from "explainer" page * removing some unnecessary comments and entries Some of the comments are more applicable in the discussion doc, than they are for developer documentation. So, let's get rid of those. * remove unnecessary "current is..." language from resource fees * [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 * [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 fee page, close #710 (#745) * Update fee page, close #710 * Apply suggestions from code review Co-authored-by: Elliot Voris <[email protected]> Co-authored-by: Leigh McCulloch <[email protected]> --------- Co-authored-by: Jane Wang <[email protected]> Co-authored-by: Elliot Voris <[email protected]> Co-authored-by: Leigh McCulloch <[email protected]> * Update fee page, close #710 (#745) * Update fee page, close #710 * Apply suggestions from code review Co-authored-by: Elliot Voris <[email protected]> Co-authored-by: Leigh McCulloch <[email protected]> --------- Co-authored-by: Jane Wang <[email protected]> Co-authored-by: Elliot Voris <[email protected]> Co-authored-by: Leigh McCulloch <[email protected]> * [Stellar Merge] Redirects for Soroban RPC pages (#757) * add a redirect for anything under the `/api` route * change the API navbar item to an external link * disable the `/api` plugin-content-docs * fix some broken links * updating a couple other misc redirects * add external links to RPC providers and usage instructions * add some redirects for RPC information docs * add an admonition to the rpc usage page * move some directories into a "learn" directory * more README.mdx files * update sidebars * add a "Learn" item to the top navbar * fix a boat-load of broken links * add whitespace back to list of operations * add more linebreak spaces * initial nginx redirects * Add Java SDK Example. (#765) * Add Java SDK Example. * Enable Java code highlights. * use a README file in the stellar data structures section * pull in changes for soroban-internals section * use a README file in soroban-internals section * move the soroban env diagram file location * fix broken links in soroban internals pages * run soroban internals pages through linter * use a README file in soroban types category * use README for contract interactions section * move migrate docs into learn directory * use a README document for the migration section * fixup some broken links in the migration section * fix a couple more broken links * quick placeholders for sq and fca00c, we'll want better copy probably * try to capture any anchor URLs used in the glossary * update existing redirects for new learn section * fix muxed accounts redirect * better README files in chain migration categories * rename "soroban-internals" to "smart contract internals" * fix broken links * fix canonical links in smart-contract-internals directory * change title of Smart Contracts Internals category page * couple tweaks * capitalization * fix link * use `.mdx` links to markdown files in fees encyclopedia page --------- Signed-off-by: Satyam Zode <[email protected]> Co-authored-by: Tyler van der Hoeven <[email protected]> Co-authored-by: Graydon Hoare <[email protected]> Co-authored-by: Alejo Mendoza <[email protected]> Co-authored-by: Jesmar Castillo <[email protected]> Co-authored-by: Julian Martinez <[email protected]> Co-authored-by: Bri <[email protected]> Co-authored-by: Siddharth Suresh <[email protected]> Co-authored-by: Leigh McCulloch <[email protected]> Co-authored-by: Iryna Telesheva <[email protected]> Co-authored-by: Iryna Telesheva <[email protected]> Co-authored-by: nmadadair <[email protected]> Co-authored-by: Alfonso Acosta <[email protected]> Co-authored-by: George <[email protected]> Co-authored-by: Sapo-Dorado <[email protected]> Co-authored-by: Julian Martinez <[email protected]> Co-authored-by: Satyam Zode <[email protected]> Co-authored-by: Satyam Zode <[email protected]> Co-authored-by: Elizabeth <[email protected]> Co-authored-by: Chad Ostrowski <[email protected]> Co-authored-by: jcx120 <[email protected]> Co-authored-by: Jane Wang <[email protected]> Co-authored-by: Jane Wang <[email protected]> Co-authored-by: Jun Luo <[email protected]>
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.
The current user guide is autogenerated from a google doc, resulting in some poor markdown. This PR updates the markdown to use our
<CodeExample>blocks, as well as make some minor changes to the flow.