Create VitePress documentation site

[Zzackllack]

This pull request sets up the VitePress documentation site for AniBridge, including configuration, theming, and initial content. The changes introduce a custom theme, color palette, navigation structure, and comprehensive documentation for API endpoints, environment variables, developer guides, and more.

Documentation site setup and configuration:

• Added docs/.vitepress/config.mts with VitePress site configuration, navigation, sidebar structure, branding, and metadata.
• Added docs/package.json and docs/pnpm-workspace.yaml to declare VitePress as a dev dependency and workspace settings. [1] [2]

Custom theming and branding:

• Added docs/.vitepress/theme/index.ts and docs/.vitepress/theme/custom.css to apply a custom color palette and enhanced hero image glow for light/dark modes and responsive screens. [1] [2]

Documentation content:

• Added comprehensive API documentation pages covering endpoints, Torznab, qBittorrent shim, jobs/events, environment variables, data model, configuration, FAQ, developer running/testing/contributing/logging guides, and runtime API examples under docs/src/. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14]

These changes establish a well-organized, branded, and developer-friendly documentation site for AniBridge.

Summary by CodeRabbit

• New Features
  • Launched a VitePress-powered documentation site with search, structured navigation, edit links, and branded theming (including dark mode and hero image glow).
• Documentation
  • Added Guides: Overview, Quickstart, Running, Configuration, Troubleshooting, FAQ.
  • Added API References: Endpoints, Jobs & Events, Torznab, qBittorrent Shim, Environment, Data Model.
  • Added Integrations: Docker Compose, Prowlarr, Sonarr.
  • Included examples and homepage content.
• Chores
  • Introduced docs tooling (scripts and workspace config) and updated ignore rules to track lockfile and relevant cache.

[coderabbitai]

Walkthrough

Adds a VitePress-based documentation site under docs/, including site config, theme with custom CSS, dev tooling (package.json, pnpm workspace), homepage and multiple sections (Guide, API, Integrations, Developer), example pages, and a web manifest. Updates .gitignore to track pnpm-lock.yaml and docs/.vitepress/cache/.

Changes

Cohort / File(s)	Summary
Repo ignore rules /.gitignore	Unignores pnpm-lock.yaml and docs/.vitepress/cache/ (and **), retains Makefile.
VitePress core setup docs/.vitepress/config.mts, docs/.vitepress/theme/index.ts, docs/.vitepress/theme/custom.css	Adds site configuration, applies custom theme CSS (brand colors, hero image glow), and re-exports default theme.
Docs tooling docs/package.json, docs/pnpm-workspace.yaml	Adds VitePress dev tooling with scripts and limits built dependencies to esbuild.
Guide docs docs/src/guide/overview.md, docs/src/guide/quickstart.md, docs/src/guide/running.md, docs/src/guide/configuration.md, docs/src/guide/faq.md, docs/src/guide/troubleshooting.md	Introduces overview, quickstart, running (Python/Docker), configuration reference, FAQ, and troubleshooting guides.
API docs docs/src/api/endpoints.md, docs/src/api/environment.md, docs/src/api/data-model.md, docs/src/api/jobs.md, docs/src/api/qbittorrent.md, docs/src/api/torznab.md	Documents public endpoints, env vars, data model, jobs/SSE, qBittorrent shim, and Torznab API with behavior and formats.
Integrations docs/src/integrations/docker.md, docs/src/integrations/prowlarr.md, docs/src/integrations/sonarr.md	Adds Docker Compose guide and configuration steps for Prowlarr and Sonarr.
Developer docs docs/src/developer/running.md, docs/src/developer/contributing.md, docs/src/developer/logging.md, docs/src/developer/testing.md	Adds local running guide, contributing guidelines, logging details, and testing/coverage instructions.
Site pages & examples docs/src/index.md, docs/src/markdown-examples.md, docs/src/api-examples.md	Adds homepage with hero and features, Markdown extensions demo, and runtime API usage examples.
Public assets docs/src/public/site.webmanifest	Adds PWA manifest with icons and theme metadata.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

I thump my paws on docs so bright,
New pages bloom in VitePress light.
With glowing hero, guides in tow,
APIs mapped, the routes now show.
Hop, hop—compose and run with cheer,
AniBridge docs are crystal clear! 🐇✨

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Free

💡 Knowledge Base configuration:

• Jira integration is disabled
• Linear integration is disabled

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 1308bfd and 0b26f33.

⛔ Files ignored due to path filters (8)

• docs/pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
• docs/src/public/apple-touch-icon.png is excluded by !**/*.png
• docs/src/public/favicon-96x96.png is excluded by !**/*.png
• docs/src/public/favicon.ico is excluded by !**/*.ico
• docs/src/public/favicon.svg is excluded by !**/*.svg
• docs/src/public/logo.png is excluded by !**/*.png
• docs/src/public/web-app-manifest-192x192.png is excluded by !**/*.png
• docs/src/public/web-app-manifest-512x512.png is excluded by !**/*.png

📒 Files selected for processing (29)

• .gitignore (1 hunks)
• docs/.vitepress/config.mts (1 hunks)
• docs/.vitepress/theme/custom.css (1 hunks)
• docs/.vitepress/theme/index.ts (1 hunks)
• docs/package.json (1 hunks)
• docs/pnpm-workspace.yaml (1 hunks)
• docs/src/api-examples.md (1 hunks)
• docs/src/api/data-model.md (1 hunks)
• docs/src/api/endpoints.md (1 hunks)
• docs/src/api/environment.md (1 hunks)
• docs/src/api/jobs.md (1 hunks)
• docs/src/api/qbittorrent.md (1 hunks)
• docs/src/api/torznab.md (1 hunks)
• docs/src/developer/contributing.md (1 hunks)
• docs/src/developer/logging.md (1 hunks)
• docs/src/developer/running.md (1 hunks)
• docs/src/developer/testing.md (1 hunks)
• docs/src/guide/configuration.md (1 hunks)
• docs/src/guide/faq.md (1 hunks)
• docs/src/guide/overview.md (1 hunks)
• docs/src/guide/quickstart.md (1 hunks)
• docs/src/guide/running.md (1 hunks)
• docs/src/guide/troubleshooting.md (1 hunks)
• docs/src/index.md (1 hunks)
• docs/src/integrations/docker.md (1 hunks)
• docs/src/integrations/prowlarr.md (1 hunks)
• docs/src/integrations/sonarr.md (1 hunks)
• docs/src/markdown-examples.md (1 hunks)
• docs/src/public/site.webmanifest (1 hunks)

---

Note

🎁 Summarized by CodeRabbit Free

Your organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://app.coderabbit.ai/login.

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbit in a new review comment at the desired location with your query.
• PR comments: Tag @coderabbit in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbit gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbit read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Join our Discord community for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbit help to get the list of available commands.

Other keywords and placeholders

• Add @coderabbit ignore or @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbit summary or @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbit or @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

• Visit our Status Page to check the current availability of CodeRabbit.
• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.