@eliware/documentation-template 
- Features
- Requirements
- Setup
- Usage
- Development
- Testing
- Troubleshooting
- Security
- Scope
- Navigation
- Contribution
- Documentation validation
- Support
- License
- Links
Package description: Eliware documentation-only repository template. Author: Eliware eliware@eliware.org. License: MIT.
This template owns reusable documentation-only structure and indexes; each derived repository owns its requirements, technical facts, and project behavior.
A private baseline for new Eliware documentation-only repositories. It includes the shared repository metadata, documentation indexes, CI workflow, and Knit deployment configuration.
Node.js 26 and npm 12 or later are required for repository validation.
Create a repository from this template, update its package name and repository
metadata, then run npm ci from the repository root.
Use the root README as the documentation entry point. Add repository-specific documentation and structured records, and keep their indexes current.
Read AGENTS.md, this README, and applicable specifications before changing files. Keep documentation in the repository that owns its content and link to other repositories for their requirements, implementation, or procedures.
Run npm test for aggregate validation. Use npm run lint, npm run audit,
npm run format, or npm run format:check for focused stages. The scripts run
through eliware-test.
Use Node.js 26 and run npm ci after dependency changes. Review the rule and
file path reported by eliware-test when validation fails.
Keep credentials, secrets, decrypted data, runtime output, and machine-specific state outside version control. Do not add plaintext secrets to documentation or structured records.
This repository is a starting point for documentation-only repositories. A derived repository owns its own documentation, structured records, and indexes. It does not contain application implementation, tests, operational procedures, runtime configuration, or copied policy from another repository.
Documentation: specifications
Replace template-specific metadata and content with the derived repository's details. Keep root and specifications indexes aligned with files on disk, then run the validation commands before handoff.
Run npm test to validate repository conventions, documentation links and
indexes, lint, formatting, and dependency security. npm run format:check is
read-only; npm run format writes formatted files.
Use the Eliware Discord community, GitHub issues, or eliware@eliware.org. Include the relevant file path and a concise description of the issue when requesting help.