Skip to content

Embed mermaid visuals in core docs#2

Merged
OgeonX-Ai merged 3 commits into
mainfrom
codex/implement-features-as-per-codex-instructions-1lu8m6
Jan 3, 2026
Merged

Embed mermaid visuals in core docs#2
OgeonX-Ai merged 3 commits into
mainfrom
codex/implement-features-as-per-codex-instructions-1lu8m6

Conversation

@OgeonX-Ai
Copy link
Copy Markdown
Contributor

Motivation

  • Improve readability and immediate context by embedding visual flowcharts into core operational docs.
  • Make diagrams discoverable and ensure each key flow is visible inline while retaining canonical diagram files.
  • Align documentation with repository completeness rules that require diagrams be referenced from related docs.

Description

  • Added embedded Mermaid flowcharts to core docs including docs/00-executive-overview.md, docs/04-reference-architecture.md, docs/05-operating-model.md, docs/11-incident-response.md, docs/12-change-and-release.md, docs/13-exception-handling.md, docs/16-logging-monitoring-siem.md, and docs/19-devsecops-pipelines.md.
  • Kept and referenced the original diagram files in docs/22-diagrams/ so the inline visuals and canonical .mmd sources remain linked.
  • Introduced visual flows for service lifecycle, shared responsibility, operating model, incident flow, change flow, exception flow, hybrid logging, and policy-as-code loop to give immediate context to readers.

Testing

  • No automated CI workflows or linters were executed as part of this change.
  • The repository includes a CI job at .github/workflows/ci.yml that will validate Markdown, run a link check, verify Mermaid blocks, and validate JSON formatting when the workflow is triggered.

Codex Task

Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: ebfd98def7

ℹ️ 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".

Comment thread site/assets/app.js
Comment on lines +1 to +4
const pages = [
{ title: "Overview", href: "pages/overview.html" },
{ title: "Service Definition", href: "pages/service-definition.html" },
{ title: "Operating Model", href: "pages/operating-model.html" },
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Fix nav hrefs for subpages

The pages array uses href: "pages/...", which works only from site/index.html. When app.js runs on site/pages/*.html (loaded via ../assets/app.js), those links resolve relative to the subpage and become site/pages/pages/..., so the navigation and search results 404 unless the user is on the root index. Consider computing a base path from window.location or using paths that are correct for both locations (e.g., ../pages/... on subpages or root-relative paths if you serve from a web root).

Useful? React with 👍 / 👎.

Copy link
Copy Markdown
Contributor Author

@OgeonX-Ai OgeonX-Ai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Test

@OgeonX-Ai OgeonX-Ai merged commit f3545f4 into main Jan 3, 2026
1 check failed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant