theam / theam/facility

Align CLI documentation with its PostgreSQL runtime dependency

Open Beginner friendly
#45 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
71
Forks
64
Avg merge
15h 38m
Merged PRs (30d)
66

Description

Context

Raised while reviewing #43. README.md calls the operator CLI “zero-dependency”, but the published package declares postgres. facility instance bootstrap imports and opens that client, and the authentication guide explicitly documents its direct PostgreSQL connection.

Problem

The package-level “zero-dependency” claim no longer matches the deliberate PostgreSQL-backed instance bootstrap added in e92c706. It misstates the published artifact's runtime contract and can send future reviews toward removing behavior the self-host bootstrap requires.

Proposed change

Replace the blanket claim with wording that accurately describes the CLI, and audit the public CLI/package documentation for the same promise. Keep the direct PostgreSQL bootstrap behavior and its runtime dependency explicit.

Why not in #43

#43 adds release plumbing and relocates existing README sections; it did not introduce the PostgreSQL bootstrap design. Resolving the product/documentation contract belongs in a focused follow-up.

Acceptance criteria

  • Public documentation no longer describes the whole CLI as zero-dependency while postgres ships in its runtime dependencies.
  • facility instance bootstrap remains documented as connecting directly to PostgreSQL.
  • Package metadata and CLI documentation describe the same runtime requirements.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the “zero-dependency” claim in README.md, then compare packages/cli/package.json with packages/cli/src/instance.mjs and apps/docs/docs/self-host/authentication.md. Audit the public CLI and package documentation for the same wording. Done means the docs state the PostgreSQL runtime requirement, preserve the direct bootstrap connection guidance, and match the package metadata.

Written by the indexing model from the issue text.

Assessment

Tech stack
postgres, typescript
Domain
cli, databases, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
78/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.