docs: address documentation issues #632

Merged

fuzzy merged 1 commit from chore/issue-docs into main

2026-08-10 18:05:05 +00:00

automation commented

2026-08-10 17:51:08 +00:00

Owner

What

Lumped documentation-issues branch (issue #522+ triage).

#540 — config auto-lookup rejects undocumented extensions — config.Load now only accepts .yaml/.yml/.json for automatic lookup; a stray .tpagectl.toml (or .ini/.env, etc.) no longer silently configures the CLI. Explicit --config <file> paths are still honored regardless of extension (tested).
#539 — recommend env/config token transport — README authentication section now documents TPAGECTL_SERVER_TOKEN and the config file as the recommended token transports and discourages --token for interactive use (process-list/history exposure).
#609 — no empty Subcommands/COMMANDS sections — the docs generator filters the auto-injected help subcommand before emitting the section, so leaf commands no longer render a dangling ## Subcommands (markdown) or .SH COMMANDS (man). Generated docs regenerated (65 files).

Triage — already resolved (closed without code change, after verification):

#547 — the flagged flags (--name/--owner/--visibility/--domain/--preview-enabled, --force, --format, --filter) are all registered today.
#594 — the auth package doc already reads keychain-first with config fallback.

Why

First lump of the #522+ issue cleanup (documentation).

Testing

config: auto-lookup rejects a .tpagectl.toml; explicit --config path.toml still loads
docs: a leaf command with only the injected help subcommand emits no ## Subcommands/.SH COMMANDS
go test -race ./... passes; golangci-lint clean; pre-commit hooks pass
Generated docs regenerated (empty sections removed)

Breaking Changes

None. Auto-lookup no longer accepts undocumented config extensions (matches the documented .yaml/.json behavior).

Closes #539
Closes #540
Closes #609

## What Lumped documentation-issues branch (issue #522+ triage). - **#540 — config auto-lookup rejects undocumented extensions** — `config.Load` now only accepts `.yaml`/`.yml`/`.json` for automatic lookup; a stray `.tpagectl.toml` (or `.ini`/`.env`, etc.) no longer silently configures the CLI. Explicit `--config <file>` paths are still honored regardless of extension (tested). - **#539 — recommend env/config token transport** — README authentication section now documents `TPAGECTL_SERVER_TOKEN` and the config file as the recommended token transports and discourages `--token` for interactive use (process-list/history exposure). - **#609 — no empty Subcommands/COMMANDS sections** — the docs generator filters the auto-injected `help` subcommand before emitting the section, so leaf commands no longer render a dangling `## Subcommands` (markdown) or `.SH COMMANDS` (man). Generated docs regenerated (65 files). **Triage — already resolved (closed without code change, after verification):** - **#547** — the flagged flags (`--name`/`--owner`/`--visibility`/`--domain`/`--preview-enabled`, `--force`, `--format`, `--filter`) are all registered today. - **#594** — the `auth` package doc already reads keychain-first with config fallback. ## Why First lump of the #522+ issue cleanup (documentation). ## Testing - [x] `config`: auto-lookup rejects a `.tpagectl.toml`; explicit `--config path.toml` still loads - [x] `docs`: a leaf command with only the injected `help` subcommand emits no `## Subcommands`/`.SH COMMANDS` - [x] `go test -race ./...` passes; `golangci-lint` clean; pre-commit hooks pass - [x] Generated docs regenerated (empty sections removed) ## Breaking Changes None. Auto-lookup no longer accepts undocumented config extensions (matches the documented `.yaml`/`.json` behavior). Closes #539 Closes #540 Closes #609

automation added 1 commit

2026-08-10 17:51:08 +00:00

docs: address documentation issues

CI / docker (pull_request) Successful in 2m55s

Details

CI / build (pull_request) Successful in 6m10s

Details

CI / lint (pull_request) Successful in 5m56s

Details

CI / docker (push) Failing after 1m14s

Details

CI / test (push) Successful in 5m51s

Details

CI / build (push) Successful in 5m52s

Details

CI / test (pull_request) Successful in 19m32s

Details

CI / lint (push) Successful in 17m52s

Details

a47e963af2

- config auto-lookup now rejects undocumented extensions: Load only
  accepts .yaml/.yml/.json for automatic lookup, so a stray
  .tpagectl.toml no longer silently configures the CLI (explicit
  --config files are still honored) (#540).
- README authentication section documents TPAGECTL_SERVER_TOKEN and the
  config file as the recommended token transports, and discourages
  --token for interactive use (#539).
- The docs generator no longer emits empty Subcommands / .SH COMMANDS
  sections on leaf commands (only the auto-injected help subcommand);
  regenerated docs (#609).

Closes #539
Closes #540
Closes #609