_docs

SyncIgnore Documentation

This directory is the release documentation for SyncIgnore.

_my_docs/ contains private or historical planning notes and is intentionally ignored. Do not use _my_docs/ as implementation truth.

Root-level phase plans, ad hoc command transcripts, and temporary test notes are not release documentation. Before making the repository public, keep only the canonical GitHub files at the root and move or remove historical notes.

User Documentation

• Installation
• Quick start
• Command reference
• Configuration
• Templates
• Language support
• Troubleshooting

Project Documentation

• Architecture
• Testing
• Roadmap
• Release checklist

Documentation Principles

• Keep the README short and link here for detail.
• Use New Zealand spelling in public documentation.
• Verify command names and options against src/syncignore/commands/ before documenting them.
• Prefer dry-run examples for filesystem-changing commands.
• Keep language support claims precise. English CLI help is complete; other CLI help languages are partial and fall back to English.
• Keep generated command output, local test transcripts, and planning notes out of the public documentation set.