The backend.ai-docs-toolkit package README documents the PDF and HTML-preview commands but omits the static-website commands (build:web, serve:web) and several option flags that already exist in the CLI. New users and contributors cannot discover how to build or serve the static documentation site, or use options like pdf --chapters/--note and build:web --strict/--optimize-images.
Why This Work is Needed
The static-website build/serve pipeline is shipped but undocumented in the package README, so developers fall back to reading source or guessing flags. Keeping the README in sync with the actual CLI surface reduces onboarding friction and support questions.
Expected Outcomes
- README documents
docs-toolkit build:web and docs-toolkit serve:web (usage + command table).
- Common Options section covers
pdf --chapters/--note, build:web --strict/--optimize-images/--optimize-images-avif, and default ports.
- Programmatic API example includes
generateWebsite.
- No functional code changes (documentation only).
JIRA Issue: FR-2912
The
backend.ai-docs-toolkitpackage README documents the PDF and HTML-preview commands but omits the static-website commands (build:web,serve:web) and several option flags that already exist in the CLI. New users and contributors cannot discover how to build or serve the static documentation site, or use options likepdf --chapters/--noteandbuild:web --strict/--optimize-images.Why This Work is Needed
The static-website build/serve pipeline is shipped but undocumented in the package README, so developers fall back to reading source or guessing flags. Keeping the README in sync with the actual CLI surface reduces onboarding friction and support questions.
Expected Outcomes
docs-toolkit build:webanddocs-toolkit serve:web(usage + command table).pdf --chapters/--note,build:web --strict/--optimize-images/--optimize-images-avif, and default ports.generateWebsite.JIRA Issue: FR-2912