onflow / onflow/docs

Update Networks Section

Open
#752 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

Outdated - Needs to be removed/replaced

Missing Elements - Needs to be added

  • We currently do not include in our documentation a quality and up to date list of Nodes as a Service providers. The goal is to add to the Node Ops list the following
    • Call out to Figment, BlockDaemon, QuickNode, Coinbase. For each of them we would link to the relevant documentation and give overview descriptions. Collaborate with Vishal on priority and positioning of each.
  • The node docs can benefit from more tangible examples of which nodes you should run for different use-cases. Create a table that highlights a simple description of each node and who its best for.
    • Explain using personas e.g. interested in policing the transactions run the collection node, interested in doing the hard work of executing transactions run the execution node etc.
  • Delete https://developers.flow.com/networks/node-ops/node-operation/node-providers
  • Add doc on all the additional flags available in node setup. Create a new section above “Monitoring and Metrics” called “Configurations” with a short introduction on flags available. @Vishal Changrani will create a table with all flags.
  • Replace the docusaurus index of ‘Networks’ with a new doc called ‘Network Overview’. Model after a more formal version of this that includes the core info from ‘So What are Blockchain Nodes, Understanding the Role of Nodes in Flow, collection, Consensus, Verification and Execution Nodes: The Core Contributors, Flow’s Consensus Algorithm.’ - Ask Vishal to review for accuracy.

Improvements - Visual Aids/Graphs/Videos

  • Make an interactive diagram of

Image

  • Make headings title case for consistency.
  • Add a button to Light Node Setup that deploys a light node directly.
  • Have page which explains node bootstrap and node setup.
  • Add full list of metrics. @Vishal Changrani to provide.
  • Fix image incompatibility with dark mode under Timing.
  • Replace comparison table with up to date values, including a brief one sentence description of each Node and specific, simple use cases for it. Add icons for each node type.
  • Update this gif image with all node types, replace it in the docs.

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 by inventorying the linked Networks, Node Operations, staking, governance, and node setup pages, along with the Docusaurus index and sidebar. Group the checklist into removals, additions, structural edits, and visual work, then confirm requirements with the named reviewers. Done means every checklist item is addressed and the updated documentation is reviewed for accuracy, navigation, consistency, and dark-mode compatibility.

Written by the indexing model from the issue text.

Assessment

Tech stack
blockchain
Domain
blockchain, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.