Skip to content

feat: add Spec-Driven Workflow documentation page #189

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rdmueller merged 4 commits into from
Mar 14, 2026
Merged

feat: add Spec-Driven Workflow documentation page #189

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a8a274a
feat: add Spec-Driven Workflow documentation page (EN/DE)
raifdmueller Mar 14, 2026
270dc60
fix: format render-docs.js with Prettier
raifdmueller Mar 14, 2026
ed48938
fix: resolve high-severity npm audit vulnerabilities
raifdmueller Mar 14, 2026
d97201c
fix: address CodeRabbit review findings
raifdmueller Mar 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1,301 changes: 1,301 additions & 0 deletions docs/spec-driven-workflow.de.html
View file
Open in desktop

Large diffs are not rendered by default.

1,300 changes: 1,300 additions & 0 deletions docs/spec-driven-workflow.html
View file
Open in desktop

Large diffs are not rendered by default.

38 changes: 38 additions & 0 deletions scripts/render-docs.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,3 +78,41 @@ renderFile(

// all-anchors.adoc uses include:: directives — resolved automatically in Node.js
renderFile(path.join(ROOT, 'docs/all-anchors.adoc'), path.join(WEB_DOCS, 'all-anchors.html'))

// Pre-rendered HTML docs (no .adoc source available) — copy with link rewriting
function copyHtmlDoc(srcPath, destPath) {
if (!fs.existsSync(srcPath)) return
try {
fs.mkdirSync(path.dirname(destPath), { recursive: true })
let html = fs.readFileSync(srcPath, 'utf-8')
// Extract content from full HTML page (between <div id="content"> and <div id="footer">)
const contentStart = html.indexOf('<div id="content">')
const contentEnd = html.indexOf('<div id="footer">')
if (contentStart !== -1) {
const titleMatch = html.match(/<h1>(.*?)<\/h1>/)
const title = titleMatch ? titleMatch[1] : ''
const content = html.slice(contentStart, contentEnd !== -1 ? contentEnd : undefined).trim()
html = `<h1>${title}</h1>\n${content}`
}
// Convert absolute Semantic Anchors links to relative hash links
html = html.replace(
/https:\/\/llm-coding\.github\.io\/Semantic-Anchors\/#\/anchor\//g,
'#/anchor/'
)
html = html.replace(/https:\/\/llm-coding\.github\.io\/Semantic-Anchors\//g, '#/')
fs.writeFileSync(destPath, html, 'utf-8')
console.log(`Copied: ${path.relative(ROOT, destPath)}`)
} catch (err) {
console.error(`Failed to copy ${path.relative(ROOT, srcPath)}:`, err.message)
process.exit(1)
}
}
Comment thread
coderabbitai[bot] marked this conversation as resolved.

copyHtmlDoc(
path.join(ROOT, 'docs/spec-driven-workflow.html'),
path.join(WEB_DOCS, 'spec-driven-workflow.html')
)
copyHtmlDoc(
path.join(ROOT, 'docs/spec-driven-workflow.de.html'),
path.join(WEB_DOCS, 'spec-driven-workflow.de.html')
)
Comment thread
coderabbitai[bot] marked this conversation as resolved.
28 changes: 14 additions & 14 deletions website/package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions website/src/components/header.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ export function renderHeader() {
<a href="#/contributing" class="nav-link text-[var(--color-text-secondary)] hover:text-[var(--color-text)] transition-colors" data-route="/contributing" data-i18n="nav.contributing">${i18n.t('nav.contributing')}</a>
<a href="#/changelog" class="nav-link text-[var(--color-text-secondary)] hover:text-[var(--color-text)] transition-colors" data-route="/changelog" data-i18n="nav.changelog">${i18n.t('nav.changelog')}</a>
<a href="#/agentskill" class="nav-link text-[var(--color-text-secondary)] hover:text-[var(--color-text)] transition-colors" data-route="/agentskill" data-i18n="nav.agentskill">${i18n.t('nav.agentskill')}</a>
<a href="#/workflow" class="nav-link text-[var(--color-text-secondary)] hover:text-[var(--color-text)] transition-colors" data-route="/workflow" data-i18n="nav.workflow">${i18n.t('nav.workflow')}</a>
</div>
<div class="flex items-center gap-3">
<button
Expand Down Expand Up @@ -144,6 +145,7 @@ export function renderHeader() {
<a href="#/contributing" class="nav-link mobile-nav-link px-3 py-2 rounded-md text-[var(--color-text-secondary)] hover:text-[var(--color-text)] hover:bg-[var(--color-bg-secondary)] transition-colors" data-route="/contributing" data-i18n="nav.contributing">${i18n.t('nav.contributing')}</a>
<a href="#/changelog" class="nav-link mobile-nav-link px-3 py-2 rounded-md text-[var(--color-text-secondary)] hover:text-[var(--color-text)] hover:bg-[var(--color-bg-secondary)] transition-colors" data-route="/changelog" data-i18n="nav.changelog">${i18n.t('nav.changelog')}</a>
<a href="#/agentskill" class="nav-link mobile-nav-link px-3 py-2 rounded-md text-[var(--color-text-secondary)] hover:text-[var(--color-text)] hover:bg-[var(--color-bg-secondary)] transition-colors" data-route="/agentskill" data-i18n="nav.agentskill">${i18n.t('nav.agentskill')}</a>
<a href="#/workflow" class="nav-link mobile-nav-link px-3 py-2 rounded-md text-[var(--color-text-secondary)] hover:text-[var(--color-text)] hover:bg-[var(--color-bg-secondary)] transition-colors" data-route="/workflow" data-i18n="nav.workflow">${i18n.t('nav.workflow')}</a>
</div>
</div>
</nav>
Expand Down
12 changes: 12 additions & 0 deletions website/src/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,7 @@ function initApp() {
addRoute('/agentskill', renderAgentSkillPage)
addRoute('/rejected-proposals', renderRejectedProposalsPage)
addRoute('/all-anchors', renderAllAnchorsPage)
addRoute('/workflow', renderWorkflowPage)

const app = document.querySelector('#app')
if (!app) return
Expand Down Expand Up @@ -217,6 +218,15 @@ function renderAllAnchorsPage() {
loadDocContent('docs/all-anchors.adoc')
}

function renderWorkflowPage() {
const pageContent = document.getElementById('page-content')
if (!pageContent) return

pageContent.innerHTML = renderDocPage()
updateActiveNavLink()
loadDocContent('docs/spec-driven-workflow.adoc')
}

function updateActiveNavLink() {
const currentRoute = window.location.hash.slice(1) || '/'
document.querySelectorAll('.nav-link').forEach((link) => {
Expand Down Expand Up @@ -419,6 +429,8 @@ function handleLanguageChange() {
loadDocContent('docs/rejected-proposals.adoc')
} else if (currentRoute === '/all-anchors') {
loadDocContent('docs/all-anchors.adoc')
} else if (currentRoute === '/workflow') {
loadDocContent('docs/spec-driven-workflow.adoc')
} else if (currentRoute === '/') {
initCardGridVisualization()
}
Expand Down
1 change: 1 addition & 0 deletions website/src/translations/de.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
"nav.contributing": "Mitwirken",
"nav.changelog": "Änderungsprotokoll",
"nav.agentskill": "AgentSkill",
"nav.workflow": "Workflow",
"main.heading": "Semantic Anchors erkunden",
"main.subheading": "Ein kuratierter Katalog klar definierter Begriffe, Methoden und Frameworks für effektive LLM-Kommunikation.",
"main.aboutLink": "Über",
Expand Down
1 change: 1 addition & 0 deletions website/src/translations/en.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
"nav.contributing": "Contributing",
"nav.changelog": "Changelog",
"nav.agentskill": "AgentSkill",
"nav.workflow": "Workflow",
"main.heading": "Explore Semantic Anchors",
"main.subheading": "A curated catalog of well-defined terms, methodologies, and frameworks for effective LLM communication.",
"main.aboutLink": "About",
Expand Down
Loading