Repository navigation
Docs cleanup: built design notes out, references up to date - #166
Merged
Merged
Conversation
… 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>
# Conflicts: # CHANGELOG.md
Co-Authored-By: Claude Opus 5.5 <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.
The docs review's recommendations, all of them.
Removed (built; git history keeps them):
architecture-view.md,trace-viewer.md,simple-install.md: features.md, quickstart.md and upgrading.md describe what was built.event-logger.md: its two unbuilt steps are now issues Event Logger as a catalog package (P1 of the event-logger plan) #164 (the logger as a catalog package) and Library resource pbt-eventlog.js: capture samples at a policy stage (R1 of the event-logger plan) #165 (pbt-eventlog.js).idmwebusage text, a test and the smoke script pointed at these notes. They now point at quickstart.md, features.md, or DirXMLDev's event-store.md. README rows removed.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'sgh/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 underdata.dir/users/<subject>/(now including Git and agent tokens), the start-up refusal, the page, the API (field names checked againstCredentialService), and old trace recordings.Corrected:
data-model.md:
drivers/<d>.name,servers.<name>and job keys;overrides/<env>.known.json;environments/plannedlists;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
simand 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.0example. §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:
docs/*.mdresolves (script);mvn packagepass;One reference outside this repo: DirXMLDev
docs/event-store.mdpoints at the removed event-logger note. That's fixed in a separate DirXMLDev PR.🤖 Generated with Claude Code