Development & docs hosting

You only need to self-host the Go API to use this MCP. The public documentation website is shared; a separate docs deployment is optional.

Develop locally

From the repository root:

make check            # Go tests and vet
make docs-install     # Bun dependencies for Astro/ZueDocs
make docs-check       # Type-check the site
make docs-build       # Build the static documentation

The unit tests use in-memory/mock storage and don’t require private credentials. For changes to catalog or account synchronization, test both normal operations and preservation of other installed Stremio add-ons.

Edit the documentation

Guides are in docs/src/content/docs/, site navigation in docs/src/data/docs.ts, and the homepage in docs/src/pages/index.astro. Please keep the main README short and link to the website rather than duplicating long instructions. Give priority to clear, agent-executable setup steps and human-friendly everyday examples.

Host a separate docs site (optional)

The repository includes a docs-only, path-filtered GitHub Actions workflow at .github/workflows/docs-deploy.yml. It builds the static Astro site in GitHub Actions and deploys prebuilt output to a second Vercel project; the Go project isn’t involved.

To use it in your own fork:

1. Create a Vercel project linked to the same GitHub repository. Configure its Root Directory as docs, Framework Preset as Astro, and disable automatic Git deployments for docs (already configured in docs/vercel.json).
2. Create a project-scoped Vercel token limited to the docs project. In the fork, store it as a GitHub Actions secret named VERCEL_TOKEN.
3. Add GitHub Actions variables VERCEL_ORG_ID and VERCEL_PROJECT_ID, corresponding to that docs project. Never commit the token.
4. Push a docs/** change to main, or run the Docs workflow manually. The action filters paths before asking Vercel to deploy, avoiding unnecessary builds.

Your docs site does not need MCP_API_KEY, the Stremio session key, or Redis credentials. Keep those only in the Go API Vercel project. If you don’t configure docs CI in your fork, simply skip deploying a custom docs site and point people to the shared website.

Public release checklist

Keep tokens out of source control and examples, review the CLI setup output for private data, run go test -race ./..., and verify the documentation build. Review the current Stremio account API behavior before shipping account-sync changes. Contributions should preserve existing streaming add-ons and must never require paid services without explicit opt-in.