docs: refresh README + docs, add troubleshooting page#8
Merged
Conversation
- README: badges, prereqs, portal screenshot; drop "coming in later
milestones" roadmap (streaming/pagination/methods/security/export
are all shipped)
- docs/operations/troubleshooting.md: new page covering 401s, portal
JSON-stub fallback, empty audit log, OIDC redirect loops,
testcontainers hangs
- fix stale /v1/page/* paths in gateway-testing.md (real routes are
/v1/pagination/{link,odata,cursor})
- releases.md: mark M3/M4 released, M5 in progress; add Breaking
Changes pointer
- deployment.md: complete dangling "Prometheus metrics endpoint lands
in." sentence (no /metrics planned); add sample access-log line,
field-source table, request_id correlation guidance
- configuration/reference.md: clarify auth.require_for_api /
auth.require_for_portal as loaded-but-unused; add note on what
actually gates /v1/* / portal / health surfaces
- expand methods.md and security.md with response schemas, "what to
assert" tables, and audit-log perspective
- cross-link architecture↔audit, configuration/auth→identity,
operations/audit↔deployment/architecture
- quickstart.md, overview.md: drop stale "M3 hasn't landed" framing
- mkdocs.yml: wire troubleshooting into Operations nav
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.
Summary
docs/operations/troubleshooting.md— covers 401s everywhere, portal JSON-stub fallback, empty audit log, OIDC redirect loops,make integrationhangs, local-passes-CI-fails, Plexara unreachable. Wired into the Operations nav inmkdocs.yml.gateway-testing.mdwas pointing at/v1/page/*paths that don't exist (real routes are/v1/pagination/{link,odata,cursor});releases.mdmarked M3 "in progress" and M4 "planned" when both are released;deployment.mdhad a dangling "Prometheus metrics endpoint lands in." sentence (no/metricsis planned today).auth.require_for_apiandauth.require_for_portalare loaded into config but never read elsewhere; reference page now says so, with a note covering what actually gates each surface today.route_nameper verb), and design rationale for why probes return 200 instead of 4xx.request_id.Test plan
make verifypasses locally (full CI-equivalent gate: fmt, mod-tidy, build-all, lint, gosec, govulncheck, semgrep, coverage ≥80%, integration via testcontainers Postgres, CodeQL, ui-verify)docs.ymlwill rebuild the mkdocs site under--strictand catch any broken markdown links/anchors)