Commit Graph
2 Commits
Author SHA1 Message Date
Markus GrafandClaude af47ac7663 docs: add comprehensive user documentation (README.md)
Implement the add-readme OpenSpec proposal with complete user-facing
documentation covering setup, workflow, and all implemented features.

Documentation includes:
- Framework introduction and feature overview
- Prerequisites (Claude Code required, Pandoc/LaTeX optional)
- Step-by-step setup instructions with profile shortcut
- Complete 12-step workflow (numbered 1-12)
- Detailed commands reference for all 7 slash commands
- Directory structure visualization with explanations
- Maintenance guidance for updates and archiving

Changes from initial draft:
- Removed Quick Start section for simplicity
- Renumbered workflow steps starting from 1 instead of 0
- Removed Example Workflow section to keep documentation concise
- Removed Best Practices section (redundant with workflow guidance)
- Removed Troubleshooting section (detailed help in CLAUDE.md)

All content focuses exclusively on implemented features. No mention of
unimplemented features like automated CV generation.

Closes OpenSpec change: add-readme

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-10 15:08:11 +01:00
Markus GrafandClaude d39be42e81 feat: add proposal for user documentation (README.md)
Create OpenSpec proposal to add comprehensive user-facing documentation
that explains setup, configuration, and usage of implemented features.

The proposal includes:
- Framework introduction and feature overview
- Prerequisites and setup instructions
- Complete workflow documentation (all 7 slash commands)
- Quick start guide for experienced users
- Directory structure explanation
- Profile setup shortcut (using Claude to help populate from docs)

Focuses only on implemented features, excludes aspirational/unimplemented
functionality like automated CV generation.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-10 14:55:33 +01:00