doc
- Repo stars 4
- License MIT
- Author repo product-factory-os
- Domain
- Documentation
- Author-declared agents
- No explicit declaration found; this is not inferred or tested compatibility
- Static check
- 94 / 100 · heuristic scan, not runtime safety proof
- Runtime evidence
- Not run; no isolated runtime test evidence is currently recorded
- Author / version / license
- @hihol-labs · MIT
- Token usage
- Lean
- Setup complexity
- Plug-and-play
- External API key
- Not required
- Operating systems
- Unspecified (assume cross-platform)
- Runtime requirements
- No explicit requirements detected
- Detected file/system behavior
-
- Read-only
- Write / modify
- Env read
- Network behavior
- Local-only
- Install commands
- None (reference only)
Heads up: Tool permissions are not declared; actual access depends on the runtime.
# Doc
Write documentation that matches the project.
## Process
1. Read existing docs and code.
2. Identify the audience: user, developer, operator, maintainer.
3. Update the smallest relevant document.
4. Include commands, environment variables, and examples when useful.
5. Verify commands if practical.
## Self-validation
Before final output, verify:
- Route, side-effect, and confirmation requirements match metadata.
- Required artifacts or read-only result are explicit.
- Verification, blockers, and next route are stated.
## Rules
- Do not document features that do not exist.
- Do not create a new docs system for a small change.
- Keep generated docs concise and maintainable.
Sections and files
Listed in source order.
sections -> Process → Self-validation → Rules
terms -> Write documentation that matches the project. · 1. Read existing docs and code. · - Route, side-effect, and confirmation requirements match metadata. · - Do not document features that do not exist.
files/cmd -> no explicit files or commands
body sha256 -> 3eba1eadda74
Process
Read existing docs and code. Identify the audience: user, developer, operator, maintainer. Update the smallest relevant document. Include commands, environment variables, and examples when useful. Verify commands if practical.
Self-validation
Before final output, verify: Route, side-effect, and confirmation requirements match metadata. Required artifacts or read-only result are explicit. Verification, blockers, and next route are stated.
Rules
Do not document features that do not exist. Do not create a new docs system for a small change. Keep generated docs concise and maintainable.