Skip to content
This repository was archived by the owner on Aug 11, 2026. It is now read-only.
This repository was archived by the owner on Aug 11, 2026. It is now read-only.

docs: reconcile repository status, version, module inventory, and GitHub snapshot #688

Description

@ahliweb

Parent epic: #679
Related versioning issue: #451

Evidence

The audit found drift including: GitHub snapshot dated 2026-07-09 reporting 6 open issues while 33 were open at audit time; SECURITY.md still describing first target 0.1.0 while package.json is 0.23.5; CONTRIBUTING.md naming compose service postgres while the service is db; and stale module/status references across AGENTS/docs.

Objective

Make generated facts reproducible and make narrative status/version statements consistent with the chosen version policy.

Scope

  • Generate module, migration, route/operation, table/RLS, test, and GitHub snapshot inventories.
  • Mark generated sections clearly and add freshness metadata.
  • Reconcile README, SECURITY, CONTRIBUTING, AGENTS, CHANGELOG, architecture, setup, and deployment docs.
  • Add docs checks for service names, internal links, and stale generated snapshots.
  • Coordinate version statements with chore(versioning): define and align package, API, AsyncAPI, and module versions #451; do not mechanically force all contract/module versions to equal package version.

Acceptance criteria

  • Documented commands and service names work.
  • Generated inventory matches repository and GitHub state at generation time.
  • Freshness policy and regeneration command are documented.
  • CI fails on committed generated-doc drift.
  • Security/support version statements are unambiguous.
  • No current CI status is claimed unless verified by the workflow.

Metadata

Metadata

Assignees

No one assigned

    Labels

    area:architectureStruktur repo, module contract, registrypriority:p1Prioritas tinggi - core domaintype:docsPerubahan dokumentasi sesuai doc 06

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions