Skip to content

jwmarshall69/my-first-docs-repo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

To-Do API Documentation

This is a sample API documentation project designed as part of a 6-month GitHub training plan for API Technical Writers.

🔧 Features

  • Modular Markdown files in /docs
  • YAML front matter and _config.yml for GitHub Pages
  • GitHub Actions for spell check and Markdown linting
  • Versioning via Git tags

📂 Structure

  • docs/: Main documentation pages
  • .github/workflows/: Automation scripts
  • _config.yml: GitHub Pages theme and metadata

🚀 Live Site

View Documentation

🤝 Contributing

See CONTRIBUTING.md

About

Practice repo for learning GitHub as an API Tech Writer

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published