Skip to main content
This project includes AI-facing discovery assets to improve documentation quality for coding agents and retrieval systems.

​
Included assets

FilePurpose
docs/llms.txtHigh-signal map of key docs routes for LLM retrieval pipelines
docs/skill.mdOperational guidance for coding agents helping with notewise workflows

​
Why this matters

  • Improves context selection quality for agentic coding tools (Claude Code, Cursor, Windsurf).
  • Reduces hallucinated command usage by exposing authoritative flows.
  • Accelerates onboarding for contributors using AI-assisted workflows.

​
Update triggers

Update both files when any of these happen:
  1. New command group or major CLI option changes.
  2. Docs navigation changes in docs/docs.json.
  3. Runtime behavior changes in output files, cache behavior, or config semantics.

​
Maintenance checklist

1

Sync page map

Update llms.txt to include any new primary guides, references, or command pages.
2

Sync behavioral truths

Update skill.md if output naming, chapter behavior, or troubleshooting flow changes.
3

Validate links and nav

Ensure all routes listed in llms.txt exist in docs/docs.json and as .mdx files on disk.
4

Run docs validation

cd docs
mint dev
mint broken-links

​
Standards

  • Keep entries short, explicit, and route-based.
  • Prefer stable canonical pages over temporary drafts.
  • Avoid ambiguous language in operational guidance in skill.md.
  • Treat these files as first-class docs artifacts in PR review.

​
MCP note

notewise itself is a CLI, not an MCP server. For MCP-enabled workflows, expose these docs through your existing docs hosting and indexing pipeline so agents can retrieve up-to-date command and reference content.

Documentation Guide

Full contributor playbook including navigation and content standards.

CI/CD

Quality gates and automated workflows that protect docs quality.