Skip to content

docs: audit project readiness and streamline contributor context #53

Description

@TusanHomichi

Problem

Project guidance had drifted behind the implementation: README described an
unusable scaffold, architecture treated implemented features as plans, and
the roadmap omitted completed Milestone 5 slices. The first documentation
refresh also overstated snapshot-bound authorization. A fresh contributor
needs concise entrypoints that route to source and decision authority, an
accurate workflow, and evidence of the current continuation state.

Outcome and acceptance criteria

  • README, roadmap, architecture, domain model, and integrity guide distinguish
    current implementation from remaining work through Milestone 5 slice 2.
  • AGENTS.md remains concise and preserves the repository contract, while a
    task index maps work to source, ADRs, formats, and relevant tests.
  • CONTRIBUTING.md owns build/verification and contribution detail; tool
    entrypoints stay thin and consistent.
  • Document local versus deployed preview behavior without credentials.
  • Audit current repository/CI readiness, run web/Rust/browser checks, and
    record material gaps with exact evidence and follow-up ownership.
  • Add the existing browser scenarios to CI; correct the PR chore(project): audit readiness and consolidate browser fixtures #55 review finding
    without claiming unimplemented service guarantees.
  • Consolidate duplicated browser process lifecycle into a shared fixture,
    prove startup/refusal/cleanup behavior, and typecheck browser code.

Primary PR: #55, also addressing #57 (browser fixture ownership). Separate
repair found by the audit: #56 (doctor changes persisted journal mode).
Existing work remains in #27, #34, #47, #49, #51, #52, and #54; #44 owns
Milestone 5.

Activity

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

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions