Skip to main content

Documentation Tooling Project (Docusaurus Site)

This project involved auditing and improving the Getting Started section for the JSONPlaceholder API using Docusaurus. The goal was to create a clean, scalable, and user-friendly docs-as-code workflow.

JSONPlaceholder Documentation

Improved Pages​

  • intro.md – Provides an overview of JSONPlaceholder and its endpoints.
  • getting-started.md – Step-by-step installation/setup guide, improved for clarity.
  • api-overview.md – Highlights 1–2 endpoints with examples and explanations.
Improvements Implemented
  • ✅ Clearer Steps: Rewrote long and confusing paragraphs into short, actionable instructions.
  • ✅ Navigation & Sidebar: Organized pages so users can easily find setup instructions and API info.
  • ✅ UI Enhancements: Added callouts for tips, accordion sections for optional details, and suggested spots for screenshots.
  • ✅ Code Examples: Added runnable examples for JSONPlaceholder endpoints using fetch and curl.

Challenges​

  • Structuring documentation for scalability while keeping it beginner-friendly.
  • Choosing the best way to integrate UI components like callouts and accordions without cluttering the page.

What I Learnt​

  • How to implement a Docs-as-Code workflow using Docusaurus.
  • Best practices for API documentation including examples, callouts, and step-by-step guidance.
  • How to make documentation visually engaging while maintaining clarity and usability.
tip

This project is part of my ongoing WriteTech Accelerator portfolio. Screenshots, additional endpoints, and enhancements will continue to be added as I develop this project further.