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

Dylan/deploy-docs-impr #35

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

dylanh724
Copy link
Contributor

About

Split the only "Testnet" deploy section into 3, fixed syntax errors, added clarity,added missing steps, clarified local hosting, ensured publish command examples added names, added instructions on how to regenerate local+testnet.

Why?

The Deployment section previously only vaguely covered testnet with some deep issues and lacking connections. Going through a few spacetime publish without a name would also create confusion when the web dashboard was introduced, likely seeing at least 2 unnamed projects if going through both the quickstart and a verbose tutorial.

Details

  • Deploy section split:
    • BEFORE: [ Testnet ]
    • AFTER: [ Overview, Hosted, Self-Hosted ]
  • In root doc overview, added a name to the publish command (to prevent confusion later, especially from the web dash)
  • Fixed syntax err: The instructions to set a default server added a server, but the current version already has local + testnet servers added.
  • Added instructions how to add back local and testnet servers via CLI after repeatedly experiencing a bug that wipes the servers.
  • The new overview section covers the general flow and high-level explanations.

@dylanh724 dylanh724 requested review from bfops and jdetter February 26, 2024 09:37
@dylanh724 dylanh724 added the documentation Improvements or additions to documentation label Feb 26, 2024
- Deploy section split:
  - BEFORE: [ Testnet ]
  - AFTER: [ Overview, Hosted, Self-Hosted ]
- In root doc overview, added a name to the publish command (to prevent confusion later)
- Added instructions how to add back `local` and `testnet` servers via CLI after repeatedly experiencing a bug that wipes the servers.
@dylanh724 dylanh724 force-pushed the dylan/deploy-docs-impr branch from 6465f3f to 752b328 Compare February 27, 2024 03:11
Copy link
Contributor

@bfops bfops left a comment

Choose a reason for hiding this comment

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

this broadly looks great, thank you! Left some minor comments.

docs/deploying/index.md Outdated Show resolved Hide resolved
docs/index.md Show resolved Hide resolved
docs/nav.js Show resolved Hide resolved
nav.ts Show resolved Hide resolved
@bfops bfops self-assigned this May 2, 2024
@jdetter jdetter removed their request for review November 8, 2024 18:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants