seerr/gen-docs
2026-06-29 15:49:39 -04:00
..
blog docs(blog): fix "monitorNewItems" feature description and previous post author (#3103) 2026-06-05 10:55:17 +02:00
scripts docs: add REST API documentation (#2981) 2026-05-13 13:27:56 +02:00
src docs: promote Nixpkgs as an official installation method (#2775) 2026-03-31 14:04:14 +02:00
static feat(ui): rebrand Jellyseerr logos to Seerr (#2406) 2026-02-13 17:37:00 +01:00
.gitignore docs: setup docusaurus for documentation (#848) 2024-06-30 03:37:56 +05:00
babel.config.js docs: setup docusaurus for documentation (#848) 2024-06-30 03:37:56 +05:00
docusaurus.config.ts docs: add OpenID Connect documentation 2026-06-29 15:49:39 -04:00
package.json fix(docs): switch to SWC minimizer to fix broken runtime bundle 2026-05-16 14:17:29 +08:00
pnpm-lock.yaml fix(docs): switch to SWC minimizer to fix broken runtime bundle 2026-05-16 14:17:29 +08:00
README.md docs: add REST API documentation (#2981) 2026-05-13 13:27:56 +02:00
sidebars.ts refactor(docs): move REST API docs to navbar and dedicated sidebar (#3040) 2026-05-16 12:12:49 +02:00
tailwind.config.js docs: setup docusaurus for documentation (#848) 2024-06-30 03:37:56 +05:00
tsconfig.json docs: setup docusaurus for documentation (#848) 2024-06-30 03:37:56 +05:00

Seerr Documentation

Seerr docs is built using Docusaurus, a modern static website generator.

Seerr docs will be available at docs.seerr.dev.

Installation

pnpm install

Local Development

pnpm start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

pnpm build

This command generates static content in the build directory, which can then be served using any static content hosting service.

Test API Rest documentation

This command generates REST API documentation.

pnpm gen-api-docs all

This command cleans REST API documentation.

pnpm clean-api-docs all

See docusaurus-openapi-docs for more information.