nuvex-docs README

The project's README from github.com/NuvexNetwork/nuvex-docs. As one markdown file: README.md.

Nuvex docs

The Nuvex documentation site. Decision records are in architecture/adr/.

The protocol, the website, and the off-chain services are separate repositories.

pnpm install
pnpm dev

The development server listens on port 3001. The public site is https://docs.nuvex.space.

nuvex-docs (NuvexNetwork/nuvex-docs)

Searching Database…

Что это?Это сайт документации Nuvex. Сам протокол, сайт и офчейн-сервисы хранятся каждый в своём отдельном репозитории — в этом репозитории только документация.
Это код протокола Nuvex или только документация?Только документация. Это отдельный сайт документации, построенный на MDX; код протокола, код сайта и офчейн-сервисы находятся в других местах.
Как запустить сайт документации локально?Запустите dev-сервер проекта, который слушает порт 3001.
Нужен ли Node.js для запуска?Да — сайт написан на MDX, который работает на тулчейне на базе Node.js, поэтому для запуска dev-сервера нужен Node.js.
Где задокументированы архитектурные и проектные решения?Записи решений хранятся в architecture/adr/ в виде Architecture Decision Records, отдельно от страниц документации для пользователей.
Можно ли найти в этом репозитории исходный код протокола Nuvex?Нет, код протокола, основной сайт и офчейн-сервисы живут каждый в своём отдельном репозитории; этот репозиторий существует чисто ради документации.
What are similar projects?docusaurus, docz, fumadocs, EIPs, nextra, cheatsheets, docs, mkdocs
Size
0.6 MB
Stars
196
Updated
CommitOct 02
Age
15d
Commits · 90 Days