This is a sample API documentation project designed as part of a 6-month GitHub training plan for API Technical Writers.
- Modular Markdown files in
/docs - YAML front matter and
_config.ymlfor GitHub Pages - GitHub Actions for spell check and Markdown linting
- Versioning via Git tags
docs/: Main documentation pages.github/workflows/: Automation scripts_config.yml: GitHub Pages theme and metadata
See CONTRIBUTING.md