feat: add Spec-Driven Workflow documentation page#189
Merged
Conversation
Adds the Semantic Anchors Development Workflow as a bilingual documentation page accessible at #/workflow. Includes nav link, route handler, language toggle support, and build pipeline integration. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Contributor
|
Warning Rate limit exceeded
⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
WalkthroughDer PR fügt zwei neue, vorgerenderte Dokumentseiten (EN/DE) zum Semantic-Anchors-Workflow hinzu, ergänzt das Render-Skript um eine copyHtmlDoc‑Hilfsfunktion sowie die SPA‑Navigation/Route Changes
Sequence Diagram(s)sequenceDiagram
participant Build as Build Script
participant Files as Docs HTML
participant FS as File System
participant SPA as Frontend Router
Build->>Files: read `spec-driven-workflow*.html`
Build->>FS: write transformed snippet via copyHtmlDoc (title + content), rewrite links
FS-->>SPA: serve `docs/spec-driven-workflow.html` (static assets)
SPA->>FS: request `/workflow` content
FS-->>SPA: return transformed doc snippet
SPA->>SPA: renderWorkflowPage updates nav and injects content
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment Tip You can disable the changed files summary in the walkthrough.Disable the |
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Updates flatted and undici to fix high-severity CVEs. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 5
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/spec-driven-workflow.de.html`:
- Line 2: Die HTML-Root-Tag setzt aktuell das falsche `lang`-Attribut (`<html
lang="en">`); bitte ändern Sie das `lang`-Attribut auf `de` (also `<html
lang="de">`) in der betroffenen Datei, und stellen Sie sicher, dass die
Website-UI weiterhin bilingual bleibt (English/German) während die
Anker-/Inhaltselemente, die bewusst auf Englisch bleiben sollen, unverändert
bleiben.
- Around line 437-438: Die externen <link> Tags für Font Awesome
("https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css"),
Highlight.js
("https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/styles/github.min.css")
und die weiteren externen Assets (auch die Google Fonts-Links erwähnt) fehlen
SRI-Hashes; berechne die korrekten Subresource Integrity (SHA256/SHA384/SHA512)
Hashes für jede Datei, füge das entsprechende integrity="sha..." Attribut und
crossorigin="anonymous" zu den betreffenden <link> Tags hinzu und verifiziere,
daß die href-URLs exakt den Dateien entsprechen, damit die SRI-Hashes gültig
sind.
In `@docs/spec-driven-workflow.html`:
- Line 1297: The external highlight.js script tag that loads
"https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/highlight.min.js"
lacks Subresource Integrity and crossorigin attributes; update the <script> tag
that references that exact URL in both documents to include a correct
integrity="sha512-..." value (obtained from the CDN or an SRI generator) and add
crossorigin="anonymous" so the tag becomes SRI-protected and served with CORS
enabled.
In `@scripts/render-docs.js`:
- Around line 82-115: The changed block in scripts/render-docs.js (notably the
copyHtmlDoc function) violates Prettier formatting rules and fails CI; run the
formatter (prettier --write scripts/render-docs.js) to fix
whitespace/quote/indentation issues, then recommit the formatted file, and
ensure the repository has Prettier/ESLint config applied to scripts/**/*.{js,py}
so future edits to copyHtmlDoc and related calls (the copyHtmlDoc invocations at
the bottom) pass CI automatically.
- Around line 83-106: copyHtmlDoc currently extracts and rewrites HTML but does
not copy referenced assets, causing broken images like workflow-diagram.png
referenced in docs/spec-driven-workflow.html and
docs/spec-driven-workflow.de.html; update the copyHtmlDoc function to detect
asset references (e.g., <img src="...">, CSS/JS links) in the read html, resolve
relative paths against srcPath, and copy those files into the destPath directory
(creating subdirs with fs.mkdirSync and using fs.copyFileSync) or,
alternatively, if the image is obsolete, remove the <img> reference from the
extracted content before writing; ensure you update the same copyHtmlDoc logic
that performs URL rewrites so assets are handled consistently and log the copied
asset paths or handle missing assets with a clear error message.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yml
Review profile: CHILL
Plan: Pro
Run ID: b821cda7-3aa5-4c9c-8573-88e22e8156ca
📒 Files selected for processing (7)
docs/spec-driven-workflow.de.htmldocs/spec-driven-workflow.htmlscripts/render-docs.jswebsite/src/components/header.jswebsite/src/main.jswebsite/src/translations/de.jsonwebsite/src/translations/en.json
- Set lang="de" on German HTML page - Add SRI integrity hashes for CDN resources (font-awesome, highlight.js) - Remove broken workflow-diagram.png image reference (file does not exist) Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
5 tasks
This was referenced Mar 14, 2026
This was referenced Mar 26, 2026
This was referenced Apr 7, 2026
2 tasks
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
3 participants
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
Changes
docs/spec-driven-workflow.html/docs/spec-driven-workflow.de.html— rendered documentation pagesscripts/render-docs.js— new build script for rendering AsciiDoc docswebsite/src/components/header.js— adds navigation linkwebsite/src/main.js— adds route handling for the new pagewebsite/src/translations/{en,de}.json— adds translation keyTest plan
npm run buildandnpm testto ensure no regressions🤖 Generated with Claude Code
Summary by CodeRabbit
Neue Features
Dokumentation