Enhance documentation completeness and add diagram links and SLA/SLO targets#1
Conversation
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 267c4b020f
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| const pages = [ | ||
| { title: "Overview", href: "pages/overview.html" }, |
There was a problem hiding this comment.
Use page-relative links to avoid broken nav on subpages
The navigation links are hard-coded as pages/... paths, which resolve correctly from site/index.html but break on any page under site/pages/ (e.g., site/pages/overview.html resolves pages/overview.html to site/pages/pages/overview.html, which doesn’t exist). This means the nav/search links won’t work on subpages. Consider using root-relative paths (if served from a web root) or computing the base path so links resolve from both the index and subpages.
Useful? React with 👍 / 👎.
Motivation
Description
docs/05-operating-model.md,docs/04-reference-architecture.md,docs/11-incident-response.md,docs/12-change-and-release.md,docs/13-exception-handling.md,docs/16-logging-monitoring-siem.md, anddocs/19-devsecops-pipelines.mdto point at files indocs/22-diagrams/.docs/07-metrics-and-kpis.mdwith a service-levelSLA/SLO targetstable and ensured the KPI catalog and sample dashboard remain present.Enhance documentation completeness and diagram links.Testing
sed -n) and confirmed the modified Markdown files were staged and committed withgit commit.Codex Task