Skip to content

Migrate documentation to markdown book or web view format #16

@jwilles

Description

@jwilles

Summary:
Migrate the current documentation to a markdown book or web view format for better accessibility and navigation.

Background:
The current documentation format may limit user experience and discoverability. Transitioning to a markdown book (e.g., using mdBook or similar) or a web-based documentation viewer will make it easier for users to read, search, and contribute to the docs.

Tasks:

  • Evaluate current documentation structure.
  • Select an appropriate markdown book or web view tool (e.g., mdBook).
  • Migrate all documentation files to the new format.
  • Update navigation, links, and structure as needed.
  • Test new documentation build and deployment.
  • Update README and contributor guides to reference the new docs system.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions