docs(readme): document admin audit history and export surfaces - #31
Open
jussaw-hermes-agent[bot] wants to merge 1 commit into
Open
docs(readme): document admin audit history and export surfaces#31jussaw-hermes-agent[bot] wants to merge 1 commit into
jussaw-hermes-agent[bot] wants to merge 1 commit into
Conversation
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.
Finding
AUD-20260728-03 — Web README understates the available admin audit and export surfaces
Summary
Updates the
web/app-structure listing inweb/README.mdso itsadmin/entry reflects the audit-history and export surfaces already present in the application.Rationale
The existing
admin/line named login, players, games, and settings but omitted the protected audit history at/admin/auditand the authenticated CSV/JSON export endpoint at/admin/export. This documentation-only correction makes those implemented administrative capabilities discoverable without changing their behavior.Implementation details
web/README.md./admin/audit./admin/export.Acceptance checklist
Validation
git diff --check— passed.git show --checkon the committed revision — passed.pnpm exec prettier --check README.mdfromweb/— failed only for pre-existing unchanged Markdown table formatting; the exactorigin/mainREADME reproduces the same failure. The changed admin line is not among Prettier's proposed formatting ranges.claude-opus-4-8) revalidation/review approved the committed scope before publication; no material correctness, security, or scope issues found.Screenshots
Screenshots: Not applicable — no user-visible UI changes.
Accessibility, security, and privacy
Risks and tradeoffs
Minimal documentation-only risk. The long
admin/description retains the existing one-entry-per-line structure-tree style rather than introducing unrelated formatting changes.Migration, rollout, and rollback
No migration, rollout action, or deployment behavior is required. Rollback is a single-commit revert with no state to unwind.
Limitations and follow-ups
This PR intentionally does not reformat the pre-existing README table debt because it is outside the approved one-line documentation scope. Deeper usage documentation for audit/export can be handled separately if desired.