Skip to content

Docs site on GitHub Pages #17

Open

Description

@codecapo

A docs site built from the repo, published on every merge to main.

Where: docs/, a new workflow

Done when

  • Pick a tool (mdBook fits a Rust project and needs no Node)
  • Pages: install, quick start, concepts (layers, models, incremental runs, quarantine), project file reference from RFC 0001, architecture, ADRs
  • Built in CI with link checking; deployed to GitHub Pages
  • Linked from the README

Depends on: #16 for the quick start page

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

    area/docsDocs, RFCs and ADRshelp wantedExtra attention is needed

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions