Skip to content

Migrate inspectrobots.org from MkDocs Material to Docusaurus; refresh content and branding #149

Description

@jeqcho

The docs site (inspectrobots.org, built by `.github/workflows/docs.yml` from `docs/` + `mkdocs.yml`) has fallen behind the README, which was recently reworked (#147) and now has a logo the site itself never uses (the navbar still shows a generic Material Design robot icon).

Scope:

  • Migrate the site from MkDocs Material to Docusaurus.
  • Preserve the load-bearing features of the current setup:
    • auto-generated Python API reference (currently mkdocstrings; needs a generation step feeding Docusaurus),
    • `llms.txt` / `llms-full.txt` at the same URLs (the README links to them),
    • existing inbound URLs (`/guide/quickstart/`, `/api/`, ...),
    • strict build in CI + GitHub Pages deploy with the `inspectrobots.org` CNAME,
    • search.
  • Refresh content to match the improved README (tagline, install flow, CLI including `view`, plugin list).
  • Use the real logo (`docs/assets/inspect-robots-logo.svg`) for navbar, favicon, and social card.

Plan will land in `plans/` per repo convention.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions