Skip to content

Commit 15475f5

Browse files
JnyJnyclaude
andcommitted
docs: Add comprehensive documentation section to CONTRIBUTING.md
Replace TBD section with detailed guidance covering local development, documentation structure, writing guidelines, and deployment process. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent f229efc commit 15475f5

File tree

1 file changed

+40
-1
lines changed

1 file changed

+40
-1
lines changed

CONTRIBUTING.md

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,46 @@ poe clean
4444

4545
## Documentation
4646

47-
_TBD_
47+
Documentation is built using [MkDocs](https://www.mkdocs.org/) with the Material theme and deployed to GitHub Pages.
48+
49+
### Local Development
50+
51+
```console
52+
# Serve docs locally with live reload
53+
poe docs-serve
54+
55+
# Build docs for production
56+
poe docs-build
57+
58+
# Deploy docs to GitHub Pages (maintainers only)
59+
poe docs-deploy
60+
```
61+
62+
### Documentation Structure
63+
64+
- `docs/index.md` - Main documentation hub with navigation
65+
- `docs/overview.md` - Template features and benefits
66+
- `docs/quickstart.md` - Getting started guide
67+
- `docs/template-guide.md` - Detailed feature documentation
68+
- `docs/customization.md` - Post-creation modification guide
69+
- `mkdocs.yml` - MkDocs configuration
70+
71+
### Writing Guidelines
72+
73+
- Keep lines under 90 columns
74+
- Use end links format instead of embedded URLs
75+
- Focus on concrete benefits over marketing language
76+
- Include code examples where helpful
77+
- Cross-reference related sections
78+
- Test all code examples before committing
79+
80+
### Documentation Deployment
81+
82+
Documentation auto-deploys to GitHub Pages when:
83+
1. Changes are merged to `main` branch
84+
2. A new release is created
85+
86+
The deployment workflow builds the docs and publishes them to the `gh-pages` branch.
4887

4988
## Releases
5089

0 commit comments

Comments
 (0)