Skip to content

Docs cleanup: built design notes out, references up to date - #166

Merged
jcombs-pointblue merged 3 commits into
mainfrom
docs-cleanup
Oct 23, 2026
Merged

jcombs-pointblue merged 3 commits into
mainfrom
docs-cleanup

Conversation

@jcombs-pointblue

Copy link
Copy Markdown
Contributor

The docs review's recommendations, all of them.

Removed (built; git history keeps them):

Rewritten as user references:

  • pull-requests.md: creating one, providers and settings, whose account (your token, else the project's with "Opened by"), token scopes, the workstation's gh / glab, roles and audit, and the API with its required fields and an example.
  • multi-user.md: what's yours and what's shared, the files under data.dir/users/<subject>/ (now including Git and agent tokens), the start-up refusal, the page, the API (field names checked against CredentialService), and old trace recordings.

Corrected:

  • data-model.md:

    • per-person connections, Git tokens and agent tokens as entities;
    • sessions;
    • the overrides file's drivers/<d>.name, servers.<name> and job keys;
    • overrides/<env>.known.json;
    • the per-object environments / planned lists;
    • the pinned certificate and fromAnyBranch.

    Also removes the "Per-person environments (Per-user or per-role vault environments #47) would add…" line (Per-user or per-role vault environments #47 is closed) and the claim that the bind password lives in the shared environments file.

  • design.md: status W0–W7 built. A box marks it historical (the server is bin/idmweb serve, per-person vault access, agents). The W3 row no longer says rollback, secrets and driver deletion "stay with the CLI".

  • connections-ui.md: a status line saying it's built (0.61.0, Connections screen is confusing: refactor the UI #131). Its layout rules still apply.

  • limits.md: the trace view keeps 50,000 records and shows 15,000 by default, both adjustable. It used to say 5,000 lines.

  • development.md: release assets include THIRD-PARTY.md; run the three smoke tests from main before tagging; the image build fetches DirXMLSimulator for sim and the agent kit.

  • hosted-install.md: the old §6 is removed. It published Point Blue's lab in this public repo: internal IP, SSH user, Harbor robot account, Keychain item names, a stale 0.11.0 example. §1 already covers pushing to your own registry. Also: "the repository itself stays private" is removed (it's public), example tags are now <version>, and §7 becomes §6.

  • README: doc table descriptions updated; design.md labelled historical.

Checks:

  • every relative link and anchor in README, SECURITY.md and docs/*.md resolves (script);
  • tsc, vitest (54) and mvn package pass;
  • the Mermaid ER diagram is checked by its rendering on GitHub.

One reference outside this repo: DirXMLDev docs/event-store.md points at the removed event-logger note. That's fixed in a separate DirXMLDev PR.

🤖 Generated with Claude Code

… data as references, fix stale docs

Removed: architecture-view.md, trace-viewer.md, simple-install.md, event-logger.md (built; the
two event-logger steps left are #164 and #165). pull-requests.md and multi-user.md are user
references with their API fields. data-model.md gains people's own connections, Git and agent
tokens, sessions, the overrides file's names, servers and jobs, and known differences.
design.md marked historical, connections-ui.md marked built, limits.md's trace buffer and
development.md's release steps corrected, the lab's internal details out of hosted-install.md.
Code comments and the usage text point at the docs that remain.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
jcombs-pointblue and others added 2 commits October 23, 2026 13:26
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@jcombs-pointblue
jcombs-pointblue merged commit d5a2fd3 into main Oct 23, 2026
2 checks passed
@jcombs-pointblue
jcombs-pointblue deleted the docs-cleanup branch October 23, 2026 18:29
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