Comprehensive documentation overhaul with new user-facing docs and historical archive

plating 2025-10-25

29 files · 3,559+ · 1,313-

10 files changed

api-reference.md New 573-line full API documentation
cli-reference.md New 416-line CLI command documentation
quick-start.md New 141-line quick start guide
examples.md New 516-line examples documentation
performance.md New 357-line performance documentation
troubleshooting.md New 277-line troubleshooting guide
authoring-bundles.md Renamed and expanded from 04-authoring-plating-bundles.md
registry-pattern.md New 269-line registry pattern documentation
index.md Expanded landing page with additional navigation
index.md Updated API index

Added docs/api-reference.md (573 lines) with full API documentation specify behavioral
1 file
- api-reference.md
Added docs/cli-reference.md (416 lines) with CLI command documentation specify behavioral
1 file
- cli-reference.md
Added quick-start, examples, performance, troubleshooting, authoring-bundles, and registry-pattern docs specify behavioral
6 files
- quick-start.md
- examples.md
- performance.md
- troubleshooting.md
- authoring-bundles.md
- registry-pattern.md
Updated docs/index.md with expanded landing page (+107 lines) specify internal
1 file
- index.md

7 files changed

API.md New 558-line archived API docs
API.md.original Moved and updated original API docs
README.md New archive future readme
bundle-discovery-pattern.md Moved bundle discovery pattern docs to archive
template-processing-pipeline.md Moved template processing pipeline docs to archive
CHANGELOG.md Deleted old changelog docs
test-animations.md Removed test animations page

Moved old API docs to docs/archive/historical/ with original versions preserved specify internal
2 files
- API.md
- API.md.original
Migrated bundle-discovery-pattern and template-processing-pipeline docs to historical archive specify internal
2 files
- bundle-discovery-pattern.md
- template-processing-pipeline.md
Removed obsolete docs (CHANGELOG.md, test-animations.md) specify internal
2 files
- CHANGELOG.md
- test-animations.md

4 files changed

Updated src/plating/cli.py with refinements decouple internal
1 file
- cli.py
Updated plating template files (adorner.tmpl.md, readme.tmpl.md) specify internal
2 files
- adorner.tmpl.md
- readme.tmpl.md

7 files changed

Removed obsolete planning documents (OPTIONS_1_AND_4_COMPLETE.md, QUALITY_IMPROVEMENTS.md, TASKS_2_AND_4_COMPLETE.md) specify internal
3 files
- OPTIONS_1_AND_4_COMPLETE.md
- QUALITY_IMPROVEMENTS.md
- TASKS_2_AND_4_COMPLETE.md
Updated README.md with expanded project description (+84 lines) specify internal
1 file
- README.md
Updated CHANGELOG.md, CONTRIBUTING.md, and CLAUDE.md specify internal
3 files
- CHANGELOG.md
- CONTRIBUTING.md
- CLAUDE.md