onflow / onflow/docs

Docs Site Revamp V1

Open
#277 0 comments 0 reactions 0 assignees View on GitHub

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.
    Screen Shot 2023-09-14 at 1 31 52 PM

  • 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.
    Screen Shot 2023-09-14 at 1 29 59 PM

  • 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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.