Skip to content

Documentation gaps: prerequisites, config table, SECURITY.md, stale ADRs #169

Description

@jpower432

Description

A few documentation gaps to address as the project matures. None are blocking, but they'll help new contributors and evaluators.

README

  • Add a Prerequisites section (Go 1.25+, Docker/Podman, make, golangci-lint) — CONTRIBUTING.md references it but it doesn't exist yet
  • Bring the config table up to date — currently lists 7 of 28+ env vars from internal/config/gateway.go
  • Link to the OpenAPI spec — the README shows 4 endpoints but the spec documents 11

Security

  • Add SECURITY.md with a vulnerability disclosure process — GitHub surfaces this in the security tab

ADRs

  • Audit ADRs that reference old architecture (PostgreSQL, ClickHouse, ConnectRPC, cmd/gateway) and update status fields — external-authz-engine.md was updated to Superseded as a start

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationllm-assistedCreated with LLM assistance

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions