Documentation
README
gstack-document-release
Use this skill to keep docs aligned with shipped behavior.
Workflow
- Inspect the current diff and identify user-visible changes.
- Map affected docs: README files, plugin READMEs, desktop docs, examples, settings, and scripts.
- Check for stale commands, paths, model/provider names, environment variables, screenshots, and troubleshooting text.
- Update only the docs that are directly affected.
- Verify links, commands, and JSON snippets where practical.
Documentation Standard
Prefer Diataxis-style clarity:
- Tutorial: first successful path
- How-to: task-specific steps
- Reference: exact flags, settings, APIs, schemas
- Explanation: architecture and tradeoffs
Output
Report:
This is the opening of the README. Read the full README on GitHub.