Docs Site Revamp V1
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 13
- Forks
- 81
- PR merge metrics
- No merged PRs in 30d
Description
Issue to be solved
The docs site includes multiple pages that are repetitive, is difficult to navigate for developers, has inconsistent quality of pages, naming conventions, dating conventions and flow. V1 is the first phase of a 3 stage plan and focused on restructuring, pruning, merging and removing existing pages on the dev site to enhance DevEx. V2 solves adding new/missing elements and fixing bugs (with search and overall), and V3 focuses on additional improvements.
Suggest A Solution
-
Follow the format listed out on the following Notion page. The new headers in the top nav are Overview, Architecture, Build, Tools and Node Ops. Links have been added to all sections except those that are already self evident given the current layout on the website.
-
Add all sections EXCEPT those that include [V2] next to their title as this indicates that these pages need to be added in the next version. Also ignore all sections that include 'Merging' as these require more work and will be
-
Remove https://developers.flow.com/ landing page and instead link directly to /build/getting-started/hello-world. Ensure that the https://flow.com/ link to Developer portal also links straight to this hello-world sub page.
-
Ensure that all old links are redirected to the new layout's content to ensure that we avoid broken links and do not ruin our SEO.
What are you currently working on that this is blocking?
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked Notion overhaul plan and the current developers.flow.com navigation and landing page. Inventory the V1 sections, then restructure, prune, or remove the specified pages, redirect old links, and point the developer portal links to /build/getting-started/hello-world. Done means the V1 layout matches the plan without broken legacy links.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100