docs: parity audit — sync all docs with v1.0.3 code state#73
Merged
Conversation
first-run: correct nsc init wizard prompt order, remove false 'fetches the schema' claim (init is offline-safe), document login verify probes, --fetch-schema, and the post-'login --new' schema-cache auto-prompt. concepts: drop non-existent 'PUT /things/{id}/ -> replace' verb (only list/get/create/update/delete + custom actions are registered).
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Batch-2 audit wrongly removed the 'PUT /things/{id}/ -> replace' line based
on an incomplete ground-truth inventory. Verified against source: a 'replace'
verb IS registered for resources with a PUT-with-id op
(build.py:178, registration.py:66-68). Restoring the line.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
- using-with-ai-agents: add required --schema to 'nsc commands' example (the one occurrence the audit missed; nsc commands --schema is required). - SKILL.md + writes-and-safety: malformed *single* JSON/YAML input is a client error (exit 6), NOT input_error/exit 4 — only a bad NDJSON/JSONL line is input_error/exit 4 (handlers.py:321 vs :329, errors.py:41/43). - SKILL.md: drop invented '2 usage/bootstrap' from the typed scripting contract (no code 2 / no bootstrap type in errors.py:EXIT_CODES; contradicted generated exit-codes.md) — footnote code 2 instead. - ci-and-automation: --max-age prune is profile-agnostic and DOES delete aged adhoc files (store.py:_find_aged_files has no adhoc guard); only the default prune spares adhoc. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Owner
Author
Adversarial review completed (2 independent reviewers)Two skeptical reviewers re-derived facts from source, ignoring the working ground-truth file (which itself had a known error). CI is green on all platforms. Real issues found & fixed in
Verified clean: scope (no auto-gen/CLAUDE.md/AGENTS.md edits), cross-file consistency ( Note:
|
Merged
thomaschristory
added a commit
that referenced
this pull request
May 16, 2026
Maintenance release: codebase-wide simplification pass (#61-#71), documentation parity audit (#73), urllib3 2.6.3->2.7.0 (#46). No CLI/config/output-contract changes vs v1.0.3. Co-authored-by: Thomas Christory <tchristory@partner.auchan.fr> Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation parity audit (post-v1.0.2 → v1.0.3 code state)
Executes the approved documentation-audit design spec (
docs/superpowers/specs/2026-05-12-documentation-audit-design.md). Brings all hand-written user-facing and contributor docs into parity with the current code onmain(952570f, version1.0.3innsc/_version.py).Method
Config/Profile/Defaults,OutputFormat,SchemaRefresh, exit codes, env vars, bundled schemas) directly fromnsc/source. Surprising facts spot-verified against source.Notable corrections (things agents/users would have gotten wrong)
nsc describedoes not exist — was referenced ~10× acrossSKILL.md,using-with-ai-agents.md,working-with-plugins.md. Removed/replaced withnsc commands --schema … --output json.nsc commandsrequires--schema— examples that omitted it would fail. Fixed everywhere.replace(PUT-with-id) verb — a real registered verb (build.py:178,registration.py:66-68) that was missing from the verb lists; restored inconcepts.md/SKILL.md, documented incommand-generation.md.http-client.mdclaimed "retries 5xx, 3 attempts". Writes are never retried on 5xx; corrected to the actual method-aware policy.daily, freshness keyed off the<hash>.meta.jsonsidecarfetched_at, forced via--refresh-schema/nsc login --fetch-schema.nsc initis offline-safe — docs claimed it fetches the schema; it does not. Wizard prompt order corrected.nsc login— documented--fetch-schemaand the post---new"Fetch and cache the live schema now?" auto-prompt (default yes);--rotatedoes not prompt/fetch.nsc skill export <dir>— newly documented in CHANGELOG/README/guides; clarified it writes<dir>/netbox-super-cli/SKILL.mdand is dry-run unless--apply.4.5.10+4.6.0(4.6.0-beta2 dropped); offline fallback is the newest manifest entry, not a version match.nsc refresh/bundled-defaultsentinel — non-existent; removed.NSC_*only (noNETBOX_*);nsc cacheonly hasprune; non-TTY output auto-switches to JSON; exit-code contract restated from source.The CHANGELOG already carried a dated
## v1.0.3section (fromaa8fccf chore(release): 1.0.3); existing entries were refined for accuracy, none duplicated.Verification
uv run mkdocs build --strict— passes (no broken links / missing nav).NSC_BENCHbenchmark gate).scripts/gen_docs.pyre-run — no drift; auto-generateddocs/reference/{cli,config,schemas,exit-codes}.mdare current and were left untouched (they are all generated, not justcli.md/schemas.md)..github/workflows/docs.ymldeploys GitHub Pages only on av*tag push (if: github.ref_type == 'tag'); PR/docs/**runs are build-only (mkdocs build --strict). Nov1.0.3tag exists (tags stop atv1.0.2;mainisv1.0.2-18-g…). So merging this PR makes the docs CI green but does not publish the live site. Publishing requires cutting thev1.0.3release tag — a full release (also triggers PyPI publish viarelease.yml) — which was deliberately not done autonomously. Tagv1.0.3when ready to release; the corrected docs will deploy then.Scope
Out of scope per spec:
CLAUDE.md,AGENTS.md, auto-generated reference pages, new pages/guides.🤖 Generated with Claude Code