You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
This PR is a "major version" bump to BOB's documentation.
Part 1/2 focuses on rm and mv changes, saving new content for Part 2/2.
Goals
Make our docs up-to-date, concise, and well-organized so users can easily find the correct answer to their question.
Create, update, and remove pages to be laser-focused on our current narrative (UX and yield for Bitcoiners), roadmap (BitVM), and product strategy (Gateway).
Create redirects for all moved pages.
High-level Changes in Part 1/2: (Re)moving pages
Remove “Contracts” section entirely
Merge “Learn” and “Build” into one section
Delete or consolidate pages that are out of date or out of scope to BOB’s current roadmap
Delete or consolidate high-level pages related to Bitcoin development, but not directly connected to BOB (e.g. Local Development and Bitcoin Testing)
Remove current landing page; instead, start at an “Introduction”-style first page (i.e. a page at the top of the sidebar)
Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.
- Reorder pages within sections
- Bring back Ethereum bridge and BTC Gas pages
- Rename user guide pages to start with intent verbs
- Delete P2P swap page; move Hello Bitcoin to top
- Fix TODOs for broken links
documentationImprovements or additions to documentation
3 participants
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.
See "Docs Revamp" on Notion in lieu of a GitHub Issue.
This PR is a "major version" bump to BOB's documentation.
Part 1/2 focuses on
rmandmvchanges, saving new content for Part 2/2.Goals
High-level Changes in Part 1/2: (Re)moving pages
Sidebar Sections Before Changes