Skip to content

docs: move the manual to MkDocs Material #501

Closed

Description

@q-soriarty

Summary

The documentation site is built with Jekyll today. Move it to MkDocs Material on the Qubernetic docs theme, so 1.2.0 publishes the manual without Jekyll.

Scope

  • The Go generator writes MkDocs Markdown for the command reference, and the navigation for it.
  • A hand-written mkdocs.yml under docs/site/; the theme comes from the brand repository as a submodule.
  • The installation guides and the authentication guide move into the site.
  • docs.yml builds under strict and deploys from main only.
  • The Jekyll site is removed.

Acceptance

  • Every old address still answers (/manual/, /manual/copia-cli_<command>).
  • go test ./... fails when a hand-written page names a command or a command page that no longer exists.
  • The workflow rules under test/workflows hold for the new docs.yml.

Activity

  1. added a commit that references this issue on Nov 16, 2026
  2. github-actions commented on Nov 16, 2026

    @github-actions

    Fixed in develop by c249c8b (PR #505).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions