evolution-gaming / kafka-flow / 29522037793
83%

DEFAULT BRANCH: master
Ran
Jobs 2
Files 106
Run time 1min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
coverage: 83.853%. Remained the same
29522037793

push

web-flow 
Upgrade docs site to Docusaurus 3 with Mermaid support (#841)

* Upgrade docs site to Docusaurus 3 with Mermaid support

Migrate the documentation website from the legacy Docusaurus 1.14.6
(Facebook-era) scaffold to Docusaurus 3, and enable Mermaid diagrams.

Site:
- Replace siteConfig.js + sidebars.json + core/Footer.js + pages/en/*
  + i18n/en.json with docusaurus.config.js, sidebars.js, and a React
  homepage under src/.
- Enable @docusaurus/theme-mermaid (markdown.mermaid: true) so ```mermaid
  fenced blocks render; add an architecture diagram to the overview page
  showing the ConsumerFlow -> TopicFlow -> PartitionFlow -> KeyFlow nesting.
- Demote the duplicate in-content h1 on the overview page so the
  front-matter title is the sole h1.
- Point the docs plugin at the existing `sbt docs/mdoc` output
  (kafka-flow-docs/target/mdoc); no changes needed to build.sbt.
- Drop the unused demo blog and template illustration assets.

Tooling:
- Stay on Yarn (regenerate yarn.lock for the Docusaurus 3 dependencies);
  pin Node 22 LTS via .nvmrc.
- CI: setup-node v4 with Node 22 + yarn cache, `yarn install --frozen-lockfile`
  / `yarn build`, and publish ./website/build (Docusaurus 3 no longer nests
  under the project name).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Qx45KV1NxKhv63R4SwfhY6

* Restore the Help page and navbar link

The Docusaurus 1 site served a /help page (linked from the navbar). Recreate
it as a Docusaurus 3 page with the same content (Browse Docs / Join the
community / Stay up to date) and re-add the Help navbar item, so the
/kafka-flow/help route is preserved. The "Browse Docs" link points to the
clean /docs/overview URL.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Qx45KV1NxKhv63R4SwfhY6

* Demote FAQ content heading so the page title renders as h1

Regression-testing the new site against the live Docusaurus 1 pa... (continued)

1776 of 2118 relevant lines covered (83.85%)

1.28 hits per line

Jobs
ID Job ID Ran Files Coverage
1 29522037793.1 106
69.57
2 29522037793.2 103
70.83
Source Files on build 29522037793