Links

API Docs Practice

Full practice repo with guides, API reference, CI, and publishing checklist.

📂 Repo Structure

• /guides → Tutorials, getting started docs
• /api → API reference, glossary, examples
• /assets → Images, screenshots, Postman exports

✅ Week 1 Tasks

• Install GitHub Desktop and VS Code
• Create this repository
• Add a README.md (you’re reading it now!)
• Commit changes and push to GitHub

🌐 GitHub Pages Setup (Week 6)

• Create a branch docs-site
• Enable GitHub Pages in repo settings
• Use index.md as your landing page
• Merge into main and test the live site

🚀 Getting Started

1. Clone this repo

   git clone https://github.com/your-username/your-repo.git
   cd your-repo

2. Install VS Code extensions (recommended)

   • Markdown All in One
   • GitHub Pull Requests
   • REST Client

3. Open in VS Code

   • Explore /guides and /api folders.
   • Try editing guides/getting-started.md.

4. Run link check workflow

   • Push a branch with a small edit (e.g., fix a typo).
   • Open a Pull Request → Actions will auto-run:
     • ✅ Link Check
     • ✅ Markdown Lint
     • ✅ Spellcheck

5. Publish with GitHub Pages

   • Create branch docs-site.
   • Enable Pages in repo settings (branch: main, folder: /root).
   • Visit your published site at: https://jwmarshall69.github.io/api-docs-practice/

🌟 Portfolio

This repository is part of a growing API Technical Writing Portfolio.
Other projects to include:

• API Docs Practice (this repo)
• OpenAPI/Swagger documentation samples
• Postman collection walkthroughs
• GitHub Pages publishing demos

👉 Keep this section updated, then share the link to showcase your work