Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move a new guide into the build section structure #748

Merged
merged 1 commit into from
Jul 3, 2024

Conversation

ElliotFriend
Copy link
Contributor

Refs: #694

@ElliotFriend ElliotFriend requested a review from briwylde08 July 2, 2024 22:19
@stellar-jenkins
Copy link

Copy link
Contributor

@briwylde08 briwylde08 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the catch

@ElliotFriend ElliotFriend merged commit 8f9e0e0 into main Jul 3, 2024
2 checks passed
@ElliotFriend ElliotFriend deleted the move-guide-file branch July 3, 2024 14:15
briwylde08 added a commit that referenced this pull request Jul 10, 2024
* chores: implmented and made updated changes to How to Upgrade a Contract

* chores: lint files

* remove unnecessary slash from a horizon redirect (#738)

* remove unnecessary slash from a horizon redirect

* reorder redirects for api references

* fix redirects for hubble

* fix some redirects for RPC

* Update the anchor platform's event service documentation (#734)

* Update README to use more informative names (#741)

* editorial nits

* Update state archival language nit (#743)

* fix nginx config.

* Update storage language

---------

Co-authored-by: overcat <4catcode@gmail.com>

* Docs - Build Tab (#703)

* fix nginx config.

* Docs - Build Tab

* Moving things around

* moving some more things around

* moving more things around

* messing with tokens

* moving and shuffling some files around

* moving some more things from the most recent `main` commits

* add a TODO about re-setting broken links configs

* shifting around token things

* update token interface to v20.5.0

* Adjustments

* start on fixing the broken linkies

* link extravaganza

* links

* links

* content updates

* content updates and formatting

* homepage

* redirects

* fix some broken links in asset issuing tutorial

* fix learn URL on index page

* moving and shuffling build/token redirects

* rename dapp frontend filename

* adjusting/tweaking some older redirects

* links

* add a couple more redirect changes

* specify the next/prev pagination items since we moved create frontend

* /docs content

* Moving assets and tokens

* links

* use mdx links in docs/README.mdx

* misc fixes in stellar.toml info page

* remove unnecessary heading in tokens quickstart page

* shuffle and reorg sidebar declarations (no affect on actual docs)

* expand smart contracts section in build sidebar

* add some frontmatter config to docs/README.mdx

* re-adding redirects that were overwritten

---------

Co-authored-by: overcat <4catcode@gmail.com>
Co-authored-by: Elliot Voris <elliot@stellar.org>

* Add stellar wallet kit to developer tools (#744)

* Add stellar wallet kit to developer tools

* Add link to docs

* Resolves Docs bounty issue 619 (#694)

* format, check

* file name change

* fix confusing file paths

* added the complete script

* Data Introduction (#701)

* Data Introduction (draft)

* Stellar RPC -> RPC

* Add descriptions to How-To Guide boxes (#730)

* fix nginx config.

* Add descriptions to How-To Guide boxes

* more descriptions

---------

Co-authored-by: overcat <4catcode@gmail.com>

* Fix algolia crawler errors (#745)

* fix some broken, old links caught by the algolia crawler

* re-generate specfile docs from changed files

* broken link in anchor platform

* fix forgotten link in rpc specfile (#747)

* fix incorrect link (#748)

* chores: updated file path of  and it's file content

* lint files

* chores: updated file path for deploy-contracts-wasm.mdx

* fix links

* chores: updated fixes pointed out by ElliotFriend

* chores: updates --source name to alice

* chores: text correction

* chores: updated changes

---------

Co-authored-by: Elliot Voris <elliot@stellar.org>
Co-authored-by: Jake Urban <10968980+JakeUrban@users.noreply.github.com>
Co-authored-by: Jane Wang <janelwang2008@gmail.com>
Co-authored-by: Bri <92327786+briwylde08@users.noreply.github.com>
Co-authored-by: overcat <4catcode@gmail.com>
Co-authored-by: Rahul Soshte <rahul.soshte4771@gmail.com>
BlaineHeffron pushed a commit to AhaLabs/stellar-docs that referenced this pull request Jul 31, 2024
* Add release notes (stellar#232)

* Update Examples, SDK and CLI v0.2.1

* Pin docker image

* Add release notes

* preview 3 start

* fix

* fix nums

* link

* FutureNet => Futurenet

* add core and horizon versions

* Revert "Add release notes (stellar#232)" (stellar#233)

This reverts commit 1823544.

* Add release notes (stellar#234)

* Update version of SDK (stellar#236)

* Update versions of software (stellar#240)

* Remove "Preview" from releases page title

* Update chanelogs

* Update soroban-rpc version

* Update Friendbot version

* updated quickstart image sha (stellar#241)

* Add changelog notes about XDR

* Add changelog notes about env

* Add other changelogs

* Add contributors

* Next Release Dev Branch (stellar#231)

* Fix links to contributors

* Add js-stellar-base and js-soroban-client versions to release notes (stellar#242)

* Reorder the nav bar (stellar#244)

* Update Examples, SDK and CLI v0.2.1

* Pin docker image

* Add release notes (stellar#234)

* Rename and move releases page

* reorder EVERYTHING

* reorder Learn between Examples and SDKs

* update wallet position

Co-authored-by: Leigh McCulloch <351529+leighmcculloch@users.noreply.github.com>

* Update the release notes (stellar#246)

* Update the release notes

* Update docs/releases.mdx

Co-authored-by: Leigh McCulloch <351529+leighmcculloch@users.noreply.github.com>

* Update release versions for upcoming release (stellar#259)

* initial ver

* update

* update

* update

* Update release page

* Support arm64 images in docs for quickstart (stellar#274)

* update all admonitions such that prettier doesn't yell

* Lots of formatting

* Reorg (stellar#290)

* Change SDK section to Reference section

* Adding JS SDK to list of SDKs

* Adding Overcat's Python SDK to list of SDKs

* Moving Networks -> Futurenet to Reference section

* Moving Releases to Reference section

* Delete Networks from main nav

Networks now lives under Reference section

* Deleting as Releases now live in Reference section

* Changing sidebar position

Temporary, this will eventually move to How-To Guides

* Update byo.mdx

* Edited Quick Start to 1. Hello World

Includes Tutorials -> Create a Project / Write a Contract / Test / Build / Run on Sandbox / Optimizing Builds

* Move Storing Data from Examples to Getting Started

* Move Deploy to Local Network to Getting Started

Moved this section from Tutorials to Getting Started

* Move Freighter wallet tutorial to Getting Started

* Update and rename 6.-connect-Freighter-wallet.mdx to 4. Connect Freighter Wallet

* Move Deploy to Futurenet to Getting Started

* Rename 4. Connect Freighter Wallet to 4. Connect Freighter Wallet.mdx

* Moved to Getting Started

* Moved to Getting Started

Removing this section

* Moved to Getting Started

Removing this as it has been moved to Getting Started

* Moved to Getting Started -> Hello World

* Moved to Getting Started -> Hello World

* Moved to Getting Started -> Hello World

* Moved to Getting Started -> Hello World

* Moved to Getting Started -> Hello World

* Moved to Getting Started -> Hello World

* Moved to Getting Started

Removing due to this section being moved

* Update Examples to How-To Guides

* Move BYO SDK to How-To Guides

* Moved to How-To Guides

* Moved invoking contracts with transactions to How-To Guides

* Removing because it's moved to How-To Guides

* Moved Token Interface to Token How-To Guide

* Remove Token Interface

Token Interface has been moved to How-To Guides -> Token

* Move Stellar Asset Contract to How-To Guides

* Delete docs/built-in-contracts directory

Moved to How-To Guides

* Move Stellar FAQs to Learn

* Delete faq.mdx

Moved to Learn

* Update authorization.mdx

Alphabetize sidebar

* Update contract-lifecycle.mdx

Alphabetizing sidebar

* Update custom-types.mdx

Alphabetizing sidebar

* Update rust-dialect.mdx

Alphabetizing sidebar

* Update debugging.mdx

Alphabetizing sidebar

* Update environment-concepts.mdx

Alphabetizing sidebar

* Update errors.mdx

Alphabetizing sidebar

* Update events.mdx

Alphabetizing sidebar

* Update gas-and-metering.mdx

Alphabetizing sidebar

* Update interacting-with-contracts.mdx

Alphabetizing sidebar

* Update persisting-data.mdx

Alphabetizing sidebar

* Update high-level-overview.mdx

Update spelling

* formatting

* formatting

* formatting

* formatting

* Update faq.mdx

* fixed broken links

* fix broken links

* fix broken links

* moar link fixes

* fixed some broken links

* added sorobanathon homepage

* add google tag manager

* Content edits made

* back to original

* Content Edit

* button location

* Content & Eligibility guidelines added

* Update sorobanathon.js

* update all admonitions such that prettier doesn't yell

* Lots of formatting

* --prose-wrap preserve

* Update releases.mdx

* update prettier

* fixed the callouts

* formatting

* fix module import

* Update sorobanathon.js

* Fixed Reorg PR

Fixed links, moved sections, deleted double sections

* Update index.js

* Updating Sorobanathon Info

* Fixed links

Many links.

* Formatting

* Change SDK section to Reference section

* Adding JS SDK to list of SDKs

* Adding Overcat's Python SDK to list of SDKs

* Moving Networks -> Futurenet to Reference section

* Moving Releases to Reference section

* Delete Networks from main nav

Networks now lives under Reference section

* Deleting as Releases now live in Reference section

* Changing sidebar position

Temporary, this will eventually move to How-To Guides

* Update byo.mdx

* formatting

* fix broken links

* Edited Quick Start to 1. Hello World

Includes Tutorials -> Create a Project / Write a Contract / Test / Build / Run on Sandbox / Optimizing Builds

* Move Storing Data from Examples to Getting Started

* Move Deploy to Local Network to Getting Started

Moved this section from Tutorials to Getting Started

* Move Freighter wallet tutorial to Getting Started

* Update and rename 6.-connect-Freighter-wallet.mdx to 4. Connect Freighter Wallet

* Move Deploy to Futurenet to Getting Started

* Rename 4. Connect Freighter Wallet to 4. Connect Freighter Wallet.mdx

* Moved to Getting Started

Removing this as it has been moved to Getting Started

* Moved to Getting Started -> Hello World

* Moved to Getting Started -> Hello World

* formatting

* fix broken links

* moar link fixes

* Update Examples to How-To Guides

* Move BYO SDK to How-To Guides

* Moved invoking contracts with transactions to How-To Guides

* Moved Token Interface to Token How-To Guide

* Remove Token Interface

Token Interface has been moved to How-To Guides -> Token

* Move Stellar Asset Contract to How-To Guides

* Delete docs/built-in-contracts directory

Moved to How-To Guides

* formatting

* fixed broken links

* Move Stellar FAQs to Learn

* Update authorization.mdx

Alphabetize sidebar

* Update contract-lifecycle.mdx

Alphabetizing sidebar

* Update custom-types.mdx

Alphabetizing sidebar

* Update rust-dialect.mdx

Alphabetizing sidebar

* Update debugging.mdx

Alphabetizing sidebar

* Update environment-concepts.mdx

Alphabetizing sidebar

* Update errors.mdx

Alphabetizing sidebar

* Update events.mdx

Alphabetizing sidebar

* Update gas-and-metering.mdx

Alphabetizing sidebar

* Update interacting-with-contracts.mdx

Alphabetizing sidebar

* Update persisting-data.mdx

Alphabetizing sidebar

* Update high-level-overview.mdx

Update spelling

* formatting

* Update faq.mdx

* fixed some broken links

* Update releases.mdx

* update prettier

* fixed the callouts

* formatting

* fix module import

* Fixed Reorg PR

Fixed links, moved sections, deleted double sections

* Fixed links

Many links.

* Formatting

* Merge cleanup

* More cleanup

* Formatting

* some small design tweaks

* copy tweaks

---------

Co-authored-by: Bri <92327786+briwylde08@users.noreply.github.com>
Co-authored-by: Anuxhya <36203801+achallagundla@users.noreply.github.com>

* Pre mainnet restructure (stellar#644)

* docs: rename "fundamentals and concepts" to "soroban internals"

* docs: remove old "under the hood" section

* docs: add tags to the various tutorials

* docs: move tutorials into one main directory

* fix broken links to old pages

* docs: renaming soroban internals in category file

* docs: remove old "command line reference" category

* docs: add tokens directory, rearrange sidebars

* docs: rearrange migration from evm guide

* docs: remove unused reference/interfaces category

* docs: move "reference" section to "resources"

* docs: move "releases" page up a level

* docs: move FAQ page up one level

* docs: move dev tools into resources directory

* docs: move testnet.mdx to networks.mdx

* docs: rearrange items in resources directory

* docs: collapse various SDK pages into two pages

* docs: move data-providers up one level

* docs: remove some empty categories, move the tutorial template

* docs: add a new getting-started page, reorganize that section

* docs: change sidebar position integers in soroban-internals

* docs: shuffling contract interaction around in soroban-internals

* style: fixing a couple small markdown nits in dapps directory

* docs: fix a broken link

* feat: start to the "guides" page(s)

* style(lint): fixing a small linting error

* remove guides placeholder

* fixing broken links

* work on guides listing. might revert this

* formatting mdx

* docs: fixing a broken link to tutorials

* style: crack at making the tutorials filterable and hidden in the sidebar

* customizing some components for the `/guides` pages and layouts

* rename index page for guides to README

* remove commented configuration option

* remove some console logging in components

* change name of index page in guides sidebar

* remove commented sidebar generation code

* remove comments and add description to sidebar generator

* rename sidebar generator file

* more work on how the 'guides' pages might look.

* docs: adjusting sidebar positions of new getting started pages

* fix some broken links in the getting-started section

* prefer "README.mdx" files where possible

* some more guides placeholder stubs

* docs(guides): More placeholder stubs for guides and categories

* feat: don't display "guides in category" page on `/guides`

* build: check/fix MDX formatting in more directories than just docs

* style: add a larger margin before more category guides

* style: more selectively increase that top margin

* docs(guides): a quick stab at a "publishing" events guide

* docs(guides): first stab at the "publish events" guide

* docs: updating tutorial descriptions

* fix a few broken links

* docs: add note about a tuple with one element

* style: couple link changes and reformats

* move fuzzing tutorial back

* change to README file in contract interactions category

* docs(guides): give a better title for the wasm metadata guide

* fixing some broken markdown links

* fix (another!) broken link

* move the guides back into the main layout of the docs directory

* add placeholder for testnet reset automation stuff

* some initial content for some guides

* markdown formatting and fixing broken links

* moving "resources" back to "reference" to fit the definition better

More like "technical reference" rather than a "reference encyclopedia"

* change some styles of the tutorial list

* removing most category pages

* some more first-drafts of guides

* fixing some category links

* include a period at the end of each tutorial description

* simplify tutorial search box placeholder text

* better description for the tutorials page

* making the pre-commit script executable

* flesh out some of the state archival guides

* first effort for some rpc ledger key guides

* fix some broken links

* add a guide on ingesting events into a db

* first effort at storage type guides

* Some more stubs, marking drafts, and a couple additions

* make not a draft to fix a broken link

* guides category descriptions in README.mdx files

* marking incomplete chain migration docs as drafts

* change some tutorial difficulty levels

* fine-tune the tutorials component styling a bit

* improving some guides organization

* fix linting errors and broken links

* include wrap instructions for native lumens

* fix broken link in contract metadata guide

* final changes to existing guides

* moving developer tools into the main sidebar

* create real redirects instead of just notes

* fix broken links in a dapps challenge page

* fix a redirect syntax error

* fix a tutorials redirect

* Add 20.1.0 section (stellar#704)

* Add 20.1.0 section

* format

* Update docs/releases.mdx

Co-authored-by: George <Shaptic@users.noreply.github.com>

* Update docs/releases.mdx

---------

Co-authored-by: George <Shaptic@users.noreply.github.com>

* use the docusaurus blog feature for meeting notes (stellar#719)

* use the docusaurus blog feature for meeting notes

* tweak the meeting notes a bit

---------

Co-authored-by: Tyler van der Hoeven <hi@tyvdh.com>

* [Do Not Merge] Updates pending vote (stellar#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

* Add v20.2.0 release to `releases.mdx`  (stellar#737)

* Update releases.mdx

* use latest versions

* add changelog

* update title

* Update resource limits and make a new reference page for them (stellar#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

* Update resource-limits-fees.mdx (stellar#746)

* Update resource-limits-fees.mdx

Add context around the phased approach

* formatting and linting

---------

Co-authored-by: Elliot Voris <elliot@stellar.org>

* Create 2024-02-22.mdx (stellar#748)

* Create 2024-02-22.mdx

* Update 2024-02-22.mdx

* Create 2024-02-15.mdx (stellar#750)

* Create 2024-02-15.mdx

* proper indents

---------

Co-authored-by: Tyler van der Hoeven <hi@tyvdh.com>

* Phase 1 updates to Soroban docs (stellar#747)

* Adding Mainnet to Networks section

-Need help with Mainnet information for Horizon API, Validator, and History Archive
-Also getting errors when clicking on Testnet and Futurenet History Archive links

* Add Mainnet information to Block Explorers

* Add Releases section for Phase 1

* put in version numbers for (most) software

* add changelong for soroban rpc

* add changelog for soroban cli

* add mainnet passphrase to protocol 20 release notes

* try another title for this version

* remove unnecessary headings

* update Horizon link for Mainnet

* add resource limits and fees to releases page

* shifting some things around in resource limits for phase 1

* use `TBD` for soroban react version placeholders

* networks placeholders

* add validator and history urls for Mainnet

---------

Co-authored-by: Elliot Voris <elliot@stellar.org>

* replace a link for indexing services in a meeting notes post (stellar#753)

* rename "releases" page to "software versions"

* format mdx in newly added pages

* create a reference sidebar and add the navbar item

* add navbar and sidebar links to meeting notes blog

* fix some broken links

* add fees disclaimer to resource page

* updates to SDP Introduction

* add phase 2 references

* rollback commit that updated software version for phase 2

* correctly spell "position" so the meetings are actually on the right

* Revert "add phase 2 references"

This reverts commit b3e553f.

* remove the extra "meeting notes" entry from reference sidebar

* fix some broken links (just a couple this time!)

* remove some old, commented-out entries from the `docs` sidebar

* add some links

* fix some soroban links to point to this site's pages

---------

Co-authored-by: Leigh McCulloch <351529+leighmcculloch@users.noreply.github.com>
Co-authored-by: shawn <sreuland@users.noreply.github.com>
Co-authored-by: Tyler van der Hoeven <hi@tyvdh.com>
Co-authored-by: Jay Geng <jay@stellar.org>
Co-authored-by: Siddharth Suresh <siddharth@stellar.org>
Co-authored-by: Tsachi Herman <24438559+tsachiherman@users.noreply.github.com>
Co-authored-by: Bri <92327786+briwylde08@users.noreply.github.com>
Co-authored-by: Anuxhya <36203801+achallagundla@users.noreply.github.com>
Co-authored-by: George <Shaptic@users.noreply.github.com>
Co-authored-by: Julian Martinez <73849597+Julian-dev28@users.noreply.github.com>
Co-authored-by: Naman Kumar <330364+namankumar@users.noreply.github.com>
Co-authored-by: Julian Martinez <julian_martinez28@outlook.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants