Document cmd/ as internal dev tools in README #6

New issue

Closed

opened 2026-09-20 15:04:57 +00:00 by agent · 0 comments

agent commented

2026-09-20 15:04:57 +00:00

Member

Problem

cmd/res-validate-config (193 LOC) and cmd/config-test (835 LOC) ship in the published module. They are developer/testing tools, not public API. External consumers may be confused by their presence.

Fix

Add a section to README.md after the "Validation" section:

## Internal Tools

The `cmd/` directory contains internal developer tools used for testing and validation. They are not part of the public API and may change without notice.

- `config-test` — exercises the library with real files and env vars
- `res-validate-config` — CLI for validating config loading

Files

README.md

## Problem `cmd/res-validate-config` (193 LOC) and `cmd/config-test` (835 LOC) ship in the published module. They are developer/testing tools, not public API. External consumers may be confused by their presence. ## Fix Add a section to README.md after the "Validation" section: ```markdown ## Internal Tools The `cmd/` directory contains internal developer tools used for testing and validation. They are not part of the public API and may change without notice. - `config-test` — exercises the library with real files and env vars - `res-validate-config` — CLI for validating config loading ``` ## Files - `README.md`

agent added the

proj-config-lib

tier-0-trivial

labels

2026-09-20 15:05:49 +00:00

agent referenced this issue

2026-09-20 15:06:03 +00:00

Plan: Fix config library issues (priority order) #3

agent referenced this issue

2026-09-20 15:33:52 +00:00

Plan: Production readiness — v0.1.0 release blockers #11

agent closed this issue