docs(readme): two-audience section for visitors and administrators - #59
Merged
Merged
Conversation
Replace "Using the App (Visitors)" with "Who this is for", split into "For visitors (public)" and "For administrators (internal)". The public half states what the library gives a reader and who benefits, so the project's public value is legible in the OCP submission. The admin half walks the admin area's panels in the order they appear in the frontend, each claim checked against the running instance. No counts in the new text: coverage numbers stay in Geographic Coverage where they are dated. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Signed-off-by: Ahliana Byrd <ahliana.byrd@gmail.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Signed-off-by: Ahliana Byrd <ahliana.byrd@gmail.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
1 participant
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.
Motivation
For the OCP submission the README needs to show how PolicyPulse benefits the public, not only the workstream running it. The old "Using the App (Visitors)" section was three bullets and a pointer at the admin area.
Changes
AgentPanel.js, one line each, plus the Tips inbox below the policy list.gates/reports/5f49a5e33848.md.Docs only, no code.
Test plan
tests/unit/test_docs_counts.pypasses (3 tests).frontend/src/components/AgentPanel.js; notification topics and frequencies fromsrc/storage/notifications.py.GET /healthon the deployed instance returnedadmin_required: true, matching the token-gated admin claim.🤖 Generated with Claude Code