Skip to content

docs(cli): add arcctl section (PR1+PR2 surface)#7

Merged
xe-nvdk merged 1 commit into
mainfrom
feat/arcctl-docs
May 31, 2026
Merged

docs(cli): add arcctl section (PR1+PR2 surface)#7
xe-nvdk merged 1 commit into
mainfrom
feat/arcctl-docs

Conversation

@xe-nvdk

@xe-nvdk xe-nvdk commented May 31, 2026

Copy link
Copy Markdown
Member

Summary

  • Adds a new `docs/cli/` section (sidebar position 11, "CLI (arcctl)") covering arcctl PR1 and PR2 surface.
  • Four pages: `index` (intro / install / status / compat), `connections` (`arcctl config` tree + precedence + TLS), `query` (table/json/csv/arrow output, SQL input precedence, timeouts), `write` (stdin/file LP input, precision validation, common patterns).
  • Implements the per-PR docs rule — every code PR ships matching docs in the same change set, not deferred.

Companion code PRs

Test plan

  • `npm run build` succeeds locally (no new broken links/anchors introduced by the new section)
  • Sidebar autogenerates correctly from `category.json` + frontmatter `sidebar_position`
  • All inter-page links use absolute `/arc/cli/...` paths (relative `./connections` resolves wrong from sibling pages in Docusaurus)

🤖 Generated with Claude Code

Companion docs for arcctl PR1 (config) and PR2 (query, write,
output formats) landing in basekick-labs/arcctl. New section under
`docs/cli/` (sidebar position 11) with:

- index.md       — what arcctl is, why, status matrix, install,
                   Arc compatibility
- connections.md — `arcctl config {create,list,set-active,delete,
                   current}` with full precedence table and TLS
                   guidance
- query.md       — `arcctl query` with table/json/csv/arrow output,
                   SQL input precedence, timeouts, exit codes
- write.md       — `arcctl write` line-protocol ingestion with
                   stdin/file input, precision validation, common
                   patterns

Implements the per-PR docs rule (every code-shipping PR ships
matching documentation alongside, not deferred).

Build verified locally with `npm run build` — no new broken links
or anchors introduced.
@xe-nvdk

xe-nvdk commented May 31, 2026

Copy link
Copy Markdown
Member Author

@gemini-code-assist review please

@xe-nvdk xe-nvdk merged commit 7e5f74f into main May 31, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant