196 ·GitHub
What is this?
This is the documentation site for Nuvex. The protocol itself, the website, and the off-chain services are each kept in their own separate repositories — this repo only contains the docs.
This is the documentation site for Nuvex. The protocol itself, the website, and the off-chain services are each kept in their own separate repositories — this repo only contains the docs.Is this the Nuvex protocol code, or just the docs?Just the docs. It is a standalone documentation site built with MDX; the actual protocol code, website code, and off-chain services live elsewhere.
Just the docs. It is a standalone documentation site built with MDX; the actual protocol code, website code, and off-chain services live elsewhere.How do I run the docs site locally?Start the project's development server, which listens on port 3001.
Start the project's development server, which listens on port 3001.Do I need Node.js to run this?Yes — the site is written in MDX, which runs on a Node.js-based toolchain, so Node.js is required to start the dev server.
Yes — the site is written in MDX, which runs on a Node.js-based toolchain, so Node.js is required to start the dev server.Where are architecture and design decisions documented?Decision records are kept under architecture/adr/ as Architecture Decision Records, separate from the user-facing docs pages.
Decision records are kept under architecture/adr/ as Architecture Decision Records, separate from the user-facing docs pages.Can I find the Nuvex protocol source code in this repo?No, the protocol code, the main website, and the off-chain services each live in their own separate repository; this repo is purely for documentation.
No, the protocol code, the main website, and the off-chain services each live in their own separate repository; this repo is purely for documentation.What are similar projects?docusaurus, docz, fumadocs, EIPs, nextra, cheatsheets, docs, mkdocs
docusaurus, docz, fumadocs, EIPs, nextra, cheatsheets, docs, mkdocsWhich topics is it in?docs, mdx, static-site, website, protocol, static-site-generator, web3, blockchain, architecture, documentation, developers, markdown
docs, mdx, static-site, website, protocol, static-site-generator, web3, blockchain, architecture, documentation, developers, markdown