docs: write docs/insights.md
- Dominant language
- TypeScript
- Stars
- 283
- Forks
- 95
- Avg merge
- 1d 2h
- Merged PRs (30d)
- 183
Description
Insights (`run insights`, `add online-insights`, `pause/resume online-insights`, `view insights`, `archive insights`) is referenced in #1577 and from the README's new Insights section but has no dedicated guide.
Should mirror `docs/recommendations.md` in shape: quick start, what it does, options, output schema. Currently `[preview]`-tagged.
Out of #1577.
Contributor guide
Research direction
Start by reading docs/recommendations.md and the README's new Insights section, then review the Insights commands referenced in #1577. Create docs/insights.md with the same shape: quick start, behavior, options, and output schema. Done means the guide covers run insights, online-insights lifecycle commands, view insights, and archive insights, while retaining the preview label.
Written by the indexing model from the issue text.
Assessment
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 86/100