feat: oxapy documentation

[j03-dev]

• chore: setup docusaurus
• chore: first documentation
• fix: nots-api md
• docs: deploy Docusaurus site to GitHub Pages
• update docs and add search docs

Summary by CodeRabbit

• New Features
  • Added a complete Docusaurus documentation website with categorized navigation, search, responsive design, and customizable light/dark themes.
  • Added a homepage highlighting performance, routing, and built-in capabilities, with quick links to setup and API references.
  • Added deployment automation for publishing documentation to GitHub Pages.
• Documentation
  • Added installation, quickstart, tutorial, guides, advanced deployment, and comprehensive API reference content covering core framework features.

[coderabbitai]

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 35f27a93-0c24-47cf-9492-d731e2545866

📥 Commits

Reviewing files that changed from the base of the PR and between 6ab7c83 and efb39fa.

⛔ Files ignored due to path filters (3)

• docs/package-lock.json is excluded by !**/package-lock.json
• docs/static/img/favicon.svg is excluded by !**/*.svg
• docs/static/img/logo.svg is excluded by !**/*.svg

📒 Files selected for processing (46)

• .github/workflows/deploy-docs.yml
• AGENTS.md
• docs/.gitignore
• docs/README.md
• docs/docs/advanced/deployment.md
• docs/docs/advanced/server-configuration.md
• docs/docs/api/cors.md
• docs/docs/api/exceptions.md
• docs/docs/api/jwt.md
• docs/docs/api/request.md
• docs/docs/api/response.md
• docs/docs/api/router.md
• docs/docs/api/serializer.md
• docs/docs/api/server.md
• docs/docs/api/session.md
• docs/docs/api/status.md
• docs/docs/api/templating.md
• docs/docs/getting-started/installation.md
• docs/docs/getting-started/quickstart.md
• docs/docs/guides/app-state.md
• docs/docs/guides/async-handlers.md
• docs/docs/guides/cors.md
• docs/docs/guides/error-handling.md
• docs/docs/guides/file-streaming.md
• docs/docs/guides/hot-reload.md
• docs/docs/guides/jwt-authentication.md
• docs/docs/guides/middleware.md
• docs/docs/guides/requests.md
• docs/docs/guides/responses.md
• docs/docs/guides/routing.md
• docs/docs/guides/serializers.md
• docs/docs/guides/sessions.md
• docs/docs/guides/static-files.md
• docs/docs/guides/templates.md
• docs/docs/intro.md
• docs/docs/tutorial/notes-api.md
• docs/docusaurus.config.ts
• docs/package.json
• docs/sidebars.ts
• docs/src/components/HomepageFeatures/index.tsx
• docs/src/components/HomepageFeatures/styles.module.css
• docs/src/css/custom.css
• docs/src/pages/index.module.css
• docs/src/pages/index.tsx
• docs/static/.nojekyll
• docs/tsconfig.json

---

📝 Walkthrough

Walkthrough

The PR adds a Docusaurus documentation site for OxAPY, including API references, guides, tutorials, site configuration, styling, and navigation. It also adds repository guidance and a GitHub Actions workflow that builds and deploys the site to GitHub Pages.

Changes

Documentation platform

Layer / File(s)	Summary
Docusaurus site foundation docs/package.json, docs/docusaurus.config.ts, docs/sidebars.ts, docs/tsconfig.json, docs/src/..., docs/.gitignore, docs/README.md	Adds the Docusaurus package, site configuration, sidebar navigation, TypeScript settings, homepage, theme styling, and local development instructions.
Core documentation and API reference docs/docs/intro.md, docs/docs/getting-started/*, docs/docs/api/*	Adds the introduction, installation and Quickstart content, plus API references for core OxAPY components.
Framework usage guides docs/docs/guides/*	Adds guides for routing, middleware, requests, responses, serializers, sessions, authentication, templates, static files, streaming, CORS, errors, state, async handlers, and hot reload.
Deployment and full application tutorials docs/docs/advanced/*, docs/docs/tutorial/notes-api.md	Adds production deployment and server configuration guidance, plus a runnable Notes API tutorial.
Documentation operations and Pages deployment .github/workflows/deploy-docs.yml, AGENTS.md	Adds documentation maintenance guidance and a GitHub Actions workflow that builds, validates, uploads, and deploys the site to GitHub Pages.

Estimated code review effort: 4 (Complex) | ~45 minutes

Possibly related PRs

• j03-dev/oxapy#46: Documents overlapping OxAPY APIs through source docstrings.
• j03-dev/oxapy#88: Introduces the hot-reload APIs documented by this PR.

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch feat/documentation

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}