Skip to content

docs: refresh README + docs, add troubleshooting page#8

Merged
jmasud merged 1 commit into
plexara:mainfrom
jmasud:main
May 12, 2026
Merged

docs: refresh README + docs, add troubleshooting page#8
jmasud merged 1 commit into
plexara:mainfrom
jmasud:main

Conversation

@jmasud
Copy link
Copy Markdown
Contributor

@jmasud jmasud commented May 12, 2026

Summary

  • README refresh — badges (CI, CodeQL, Go reference, license), prereqs section, portal screenshot, "why not httpbin/mockoon/Prism?" angle. Drop "Coming in later milestones" roadmap (streaming / pagination / methods / security / export are all shipped).
  • New docs/operations/troubleshooting.md — covers 401s everywhere, portal JSON-stub fallback, empty audit log, OIDC redirect loops, make integration hangs, local-passes-CI-fails, Plexara unreachable. Wired into the Operations nav in mkdocs.yml.
  • Factual drift fixesgateway-testing.md was pointing at /v1/page/* paths that don't exist (real routes are /v1/pagination/{link,odata,cursor}); releases.md marked M3 "in progress" and M4 "planned" when both are released; deployment.md had a dangling "Prometheus metrics endpoint lands in." sentence (no /metrics is planned today).
  • Honest config docsauth.require_for_api and auth.require_for_portal are loaded into config but never read elsewhere; reference page now says so, with a note covering what actually gates each surface today.
  • Expand methods.md and security.md — per-endpoint response schemas, "what to assert" tables, audit-log perspective (route_name per verb), and design rationale for why probes return 200 instead of 4xx.
  • Cross-linking — architecture↔audit, configuration/auth→identity, audit→deployment for request_id correlation.
  • Observability — sample access-log JSON line, field-source table (which middleware writes which field), and the SQL pattern for joining audit rows on request_id.

Test plan

  • make verify passes locally (full CI-equivalent gate: fmt, mod-tidy, build-all, lint, gosec, govulncheck, semgrep, coverage ≥80%, integration via testcontainers Postgres, CodeQL, ui-verify)
  • CI green on this PR (docs.yml will rebuild the mkdocs site under --strict and catch any broken markdown links/anchors)
  • Spot-check rendered docs site for the new troubleshooting page and the cross-link additions

- 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
@jmasud jmasud merged commit aa73d88 into plexara:main May 12, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant