Development Workflow

Purpose

Daily workflow for working inside the Nrgy.js monorepo. For release commands see release_workflow.md.

Repository Layout

• packages/*: publishable packages.
• docs/*: project, package, and contributor documentation (source of truth).
• website/*: generated documentation site.
• benchmarks/*: local benchmark scenarios.

Common Commands

npm install           # bootstrap workspaces
npm run format        # biome --write
npm run check         # biome + tsc --noEmit
npm run test          # vitest (single run)
npm run build         # tsdown

Expected Flow for Source Changes

1. Update the source file and colocated tests.
2. Update colocated documentation for the changed module (see docs_requirements.md).
3. Update the package README.md if the public API or usage story changed.
4. Run npm run check.
5. Run npm run test for behavioral changes.

Documentation Website Workflow

The source of truth for product and contributor docs is the repository docs/* tree, not website/docs/content/*. The website content under website/docs/content/* and website/docs/ru/content/* is generated by website/scripts/generate-content.mjs. When editing documentation, update the source files in docs/* first and keep the matching *.ru.md files in sync.

Website Commands

Run commands from website/package.json:

cd website
npm run dev           # regenerate content + start VitePress dev server
npm run build         # regenerate content + verify the site builds

When Website Config Must Be Updated

• If the documentation structure changes, update the sidebar and navigation in website/docs/.vitepress/config.ts.
• If docs move between sections, verify that generated routes under website/docs/content/docs/* still match the configured links.
• If public assets are added for the site, place them in docs/assets/* or website/docs/public/* depending on whether they should be copied by the content generator.