Skip to content

docs: full documentation pass for the v1.3.0 feature/hardening batch#111

Merged
thomaschristory merged 5 commits into
mainfrom
docs/phase6-pass
Jun 25, 2026
Merged

docs: full documentation pass for the v1.3.0 feature/hardening batch#111
thomaschristory merged 5 commits into
mainfrom
docs/phase6-pass

Conversation

@thomaschristory

Copy link
Copy Markdown
Owner

Full documentation pass reflecting the nine Phase-6 changes merged into main (issues #2, #3, #4, #5, #6, #9, #12, #16, #90).

What changed

  • CHANGELOG.md — new ## v1.3.0 — unreleased section (Added: singular aliases, --workers, dynamic completion, audit_redaction: full; Changed: ~/.nsc 0700, Node 24, workflow permissions, release SHA pins + Dependabot, e2e 4.5/4.6 matrix), with footnote issue links.
  • README.md / docs/index.md--workers example, dynamic-completion examples, audit_redaction: full note, a "Curated aliases" section; retired the now-shipped "post-1.0 roadmap" notes.
  • Guideswrites-and-safety (--workers), ci-and-automation (faster bulk loads + rate-limit caution), install (dynamic completion), concepts/first-run (singular aliases), managing-profiles (--profile <TAB>), working-with-plugins (cross-tag alias resolution). audit-log.md already covered full mode (verified, untouched).
  • Architecturehttp-client (concurrency + audit-append lock, redaction modes, ensure_private_dir 0700), overview + caching (new nsc/completion/ package, cache-backed completion).
  • Contributingdevelopment (e2e 4.5/4.6 matrix, Node 24, least-privilege permissions, Dependabot).
  • SKILL.md--workers, TAB completion, audit_redaction safe/full.
  • CLAUDE.md — added nsc/completion/ to the architecture cheat sheet; AGENTS.md regenerated from it.

Validation

  • gen_docs.py --check and sync_agents_md.py --check both green (auto-generated reference + AGENTS.md fresh).
  • mkdocs build --strict passes (no broken links/nav).
  • No code/version/pyproject changes; audit-log.md reference docs untouched.

Version bump + date for v1.3.0 are intentionally left for the separate release step.

Thomas Christory and others added 5 commits June 25, 2026 22:26
Add an unreleased v1.3.0 CHANGELOG section covering nine merged changes:
singular alias forms (#6), --workers on bulk writes (#3), dynamic shell
completion (#2), audit_redaction: full (#5), and the CI/supply-chain and
state-root hardening (#90, #9, #12, #16, #4). Update the README writing,
completion, audit, and a new curated-aliases section, and mirror the four
user-facing features into the docs site home highlights.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
- concepts/first-run: curated singular aliases (device == devices)
- install: dynamic TAB completion from cached schema
- writes-and-safety: --workers N (default 1, max 32) for parallel bulk writes
- ci-and-automation: faster bulk loads via --workers with rate-limit caution

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Document the nine just-merged changes across the skill, contributor, and
architecture docs:

- --workers N (default 1, max 32) for bulk writes: SKILL.md write patterns
  and http-client.md (ThreadPoolExecutor over sync httpx, serialized audit
  append lock).
- Dynamic shell completion (nsc/completion/): component listing in
  overview.md, cache-backed at TAB time in caching.md, TAB hints in SKILL.md
  and managing-profiles.md.
- Curated singular aliases + cross-tag/plugin alias resolution noted in
  working-with-plugins.md; SKILL.md verified consistent.
- audit_redaction: full mode (5-key, sanitized url) in http-client.md and
  SKILL.md; default stays safe.
- ~/.nsc clamped to 0700 via shared ensure_private_dir() in http-client.md.
- CI: e2e matrix over NetBox 4.5/4.6, Node 24 runners, least-privilege
  permissions, Dependabot for github-actions in development.md.
- CLAUDE.md cheat sheet gains nsc/completion/ entry.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@thomaschristory thomaschristory merged commit ab273ad into main Jun 25, 2026
10 checks passed
@thomaschristory thomaschristory deleted the docs/phase6-pass branch June 25, 2026 20:34
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