স্কিপ করে মূল কন্টেন্ট এ যান

Using Docusaurus in Your Application Workflow

This page explains how teams use Docusaurus in real projects.

Typical Team Workflow​

  1. Feature owner updates docs with code changes.
  2. PR includes docs and implementation together.
  3. CI validates build and broken links.
  4. Docs are deployed with each release.
  • docs/getting-started for onboarding
  • docs/guides for task-based tutorials
  • docs/reference for API and config details
  • docs/runbooks for operational procedures

CI Validation​

In CI pipeline, run:

npm ci
npm run build

Fail build on broken links to keep docs reliable.

Versioning Docs for Releases​

Use Docusaurus docs versioning when your app has multiple supported versions.

Typical model:

  • current docs for latest release
  • versioned docs for older supported releases

Deployment Options​

Common deployment targets:

  • GitHub Pages
  • Netlify
  • Vercel
  • Self-hosted Nginx/Apache

Choose based on your organization controls and release process.

Collaboration Best Practices​

  • Define docs ownership per section
  • Add review checklist for docs quality
  • Keep style guide in a docs standards page
  • Track outdated pages during each release