docs: bring the documentation to the suite standard; cover bff and pep - #55
Merged
Merged
Conversation
README: pitch, Why and a redrawn architecture diagram now include bff and pep; the httpware table lists Metrics / MetricsHandler; requirements no longer claim ctxutil needs Socrate; package sections are tightened and link to pkg.go.dev; "Production usage" becomes "Used by" with checkable repositories; Contributing and License follow the suite standard. Integration guide: OAuth 2.1 / OpenID Connect wording, new BFF (7.1) and pep (10) sections with examples compiled against the module, browser apps steered to the BFF with client-held tokens kept as a labelled alternative, and the admin port described as 8081 in the default deployment. Links to the private server repository are plain text. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01GKRxaeYxyDhmt42cehLsGA
SECURITY.md states the controls instead of review IDs and names the server repository in plain text. CONTRIBUTING.md drops the private link and completes the pull-request steps. The PR template checklist is the full local gate, including govulncheck. The issue config keeps only the security contact. CHANGELOG.md gets the standard header, plain wording for review documents that do not exist in the tree, version link references, and an Unreleased entry for this documentation change. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01GKRxaeYxyDhmt42cehLsGA
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.
What and why
This brings the README, the integration guide and the contributor files to the documentation standard of the owner's public repos (ascenda-frontend, ascenda-backend, ha-vigie). It also fixes the places where the docs no longer matched the code. It is docs only: no
.go,go.modor workflow changes.README:
bff(the Backend-for-Frontend runtime) andpep(central policy enforcement), which are now the library's main features and were previously missing from the pitch, the "Why" and the diagram.httpwaretable gainsMetrics(service)/MetricsHandler().ctxutilneeds Socrate.go.modand imports.docs/CLIENT-INTEGRATION.md:
/bff/sessionCSRF pattern, and a new section onpep. Both examples were compiled against the real API in a throwaway module.Public-visitor hygiene:
ovander/go-oauth2; it is named in plain text.SECURITY-AUDIT.md,SECURITY-ARCHITECTURE.md,CR-…pass2/3.md) are reworded. It gains the standard header and link references for 1.8.0–1.13.0.PR template: the checklist is now the full local gate, including
govulncheck.How it was tested
go build ./... && go vet ./...pass. No code changed.bffandpepexamples and the new README snippets compile against the module (throwawaymainwith areplacedirective, deleted afterwards).go-oauth2hyperlinks, Go Report Card badge, or references to missing files remain.## [Unreleased]inCHANGELOG.md.Not verified: older snippets for tiering, aigateway and ailang were checked against signatures but not compiled. The server endpoints described in the guide were spot-checked, not exhaustively checked against the server.
Compatibility
No exported API change. Documentation only.
🤖 Generated with Claude Code
https://claude.ai/code/session_01GKRxaeYxyDhmt42cehLsGA
Generated by Claude Code