DOCUMENTATION.md

Documentation Guide

The project documentation lives in docs/ and uses Docusaurus 3 with pnpm.

Commands

cd docs

# Install dependencies
pnpm install

# Local dev server with hot reload
pnpm start

# Production build
pnpm build

Structure

• docs/docs/ — Current (next) version of docs, auto-generates sidebar from folder structure
  • docs/docs/usage/ — "Using RestSharp" guides (basics, client, request, execute, response, example)
  • docs/docs/advanced/ — Advanced topics (authenticators, configuration, serialization, interceptors, error handling)
  • docs/docs/intro.md — Getting started page
  • docs/docs/changelog.md — Release changelog
• docs/versioned_docs/ — Frozen snapshots for past versions (v110–v113)
• docs/versioned_sidebars/ — Sidebar configs for each frozen version
• docs/versions.json — List of released doc versions
• docs/src/pages/ — Standalone pages (migration guide, support)
• docs/docusaurus.config.ts — Site config (URL, navbar, footer, plugins, versioning)
• docs/sidebars.ts — Sidebar config (autogenerated from directory structure)

Versioning

Docs use Docusaurus versioned docs. docs/docs/ is the "next" (unreleased) version. To cut a new version: pnpm docusaurus docs:version vXXX. This copies docs/docs/ into versioned_docs/version-vXXX/ and creates a matching sidebar file. Update docusaurus.config.ts to add the new version label.

Writing Docs

• Markdown files with optional frontmatter (sidebar_position, title, sidebar_label)
• Category ordering via _category_.json files in each directory
• Code blocks use csharp language identifier for syntax highlighting
• Edit current docs in docs/docs/; do not modify versioned_docs/ unless backporting fixes