Skip to content

Migrate docs to Docouture - #9

Merged
sergiobe-itx merged 58 commits into
mainfrom
feature/migrate-docs-to-docouture
Sep 30, 2026
Merged

sergiobe-itx merged 58 commits into
mainfrom
feature/migrate-docs-to-docouture

Conversation

@sergiobe-itx

Copy link
Copy Markdown
Contributor

Summary

Migrate CerbIA’s documentation from Next.js/Fumadocs to Docouture 1.1.1 and Antora.

  • Convert the existing documentation to AsciiDoc, organized into product-wide sections and six package modules.
  • Preserve the marketing home, branding, code examples, and Mermaid diagrams.
  • Replace the hand-written docs workflows with the CLI-generated Docouture workflow set, adapted with clearly marked temporary workarounds.
  • Support prerelease documentation from main, numbered releases through docs/v* tags, and a latest copy.
  • Restore the CLI-generated link checker and retain the temporary search-URL prefix fix.
  • Remove obsolete Fumadocs files, migration scripts, and legacy URL compatibility support.
  • Update local build commands and contributor instructions.

Checklist

  • Commits are signed (git commit -S)
  • Commit messages follow Conventional Commits
  • Documentation has been updated

Additional context

Validation

  • Local Antora builds succeeded using real Kroki-rendered Mermaid diagrams.
  • Prerelease and multi-version build fixtures were exercised.
  • All 32 search-index tests passed, covering versioned URLs, latest-copy behavior, idempotence, traversal rejection, and symlink protection.
  • The generated Linkinator checker was exercised with successful and broken-link fixtures.

First publication

This PR should be merged without docs/release or release-type/* labels to test prerelease publication without initiating a docs or code release.

After the first successful publish creates gh-pages, configure GitHub Pages to serve gh-pages → / (root). The GitHub App credentials and repository permissions are configured, but remote publication has not yet been exercised.

@sergiobe-itx
sergiobe-itx marked this pull request as ready for review September 30, 2026 08:58
@sergiobe-itx
sergiobe-itx requested a review from a team as a code owner September 30, 2026 08:58
@github-actions

Copy link
Copy Markdown
Contributor

❗ This Pull Request will not trigger a docs release

A Pull Request with no docs/release label will not trigger a docs site release — label it docs/release if you want this merge to release the docs site.

@github-actions

Copy link
Copy Markdown
Contributor

❌ No changes in CHANGELOG.md

Update the ## [Unreleased] section listing the changes for this release before merging.

@ivanasabi ivanasabi added the skip-release Do not publish a release for this change. label Sep 30, 2026
@github-actions

Copy link
Copy Markdown
Contributor

❗ This Pull Request will not trigger a docs release

A Pull Request with no docs/release label will not trigger a docs site release — label it docs/release if you want this merge to release the docs site.

@github-actions

Copy link
Copy Markdown
Contributor

Release Preview

This pull request has the skip-release label and will not create a Python release.

Comment thread examples/cli-usage/README.md Outdated

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copilot review overview

🟡 Changes recommended

One or more issues must be addressed before approval.

Review effort: Lite
Findings: 1 Medium severity

Open (1)
What changed in this PR

Migrates CerbIA documentation from Next.js/Fumadocs to Docouture/Antora with versioned publishing, AsciiDoc content, search-index normalization, and link checking.

Changes:

  • Converts product, component, and package documentation to AsciiDoc modules.
  • Replaces legacy Fumadocs configuration, UI, and workflows.
  • Adds versioned publishing workflows and updated documentation links.
File Description
README.md Updated as part of this pull request.
packages/​cerbia/​README.md Updated as part of this pull request.
packages/​cerbia-protectai/​README.md Updated as part of this pull request.
packages/​cerbia-presidio/​README.md Updated as part of this pull request.
packages/​cerbia-ml/​README.md Updated as part of this pull request.
packages/​cerbia-core/​README.md Updated as part of this pull request.
packages/​cerbia-cli/​README.md Updated as part of this pull request.
Makefile Updated as part of this pull request.
examples/​README.md Updated as part of this pull request.
examples/​programmatic-usage/​README.md Updated as part of this pull request.
examples/​custom-loader/​README.md Updated as part of this pull request.
examples/​cli-usage/​README.md Updated as part of this pull request.
docs/​tsconfig.json Updated as part of this pull request.
docs/​supplemental-ui/​ui.yml Updated as part of this pull request.
docs/​supplemental-ui/​partials/​head-styles.hbs Updated as part of this pull request.
docs/​supplemental-ui/​favicon.png Updated as part of this pull request.
docs/​supplemental-ui/​favicon.ico Updated as part of this pull request.
docs/​supplemental-ui/​css/​mobile-content-overflow.css Updated as part of this pull request.
docs/​src/​modules/​ROOT/​pages/​index.adoc Updated as part of this pull request.
docs/​src/​modules/​main/​pages/​reference-overview.adoc Updated as part of this pull request.
docs/​src/​modules/​main/​pages/​quickstart.adoc Updated as part of this pull request.
docs/​src/​modules/​main/​pages/​prerequisites.adoc Updated as part of this pull request.
docs/​src/​modules/​main/​pages/​packages.adoc Updated as part of this pull request.
docs/​src/​modules/​main/​pages/​logging.adoc Updated as part of this pull request.
docs/​src/​modules/​main/​pages/​i18n.adoc Updated as part of this pull request.
docs/​src/​modules/​main/​pages/​guides-overview.adoc Updated as part of this pull request.
docs/​src/​modules/​main/​pages/​gate.adoc Updated as part of this pull request.
docs/​src/​modules/​main/​pages/​contributing.adoc Updated as part of this pull request.
docs/​src/​modules/​main/​pages/​components/​score-aggregators/​mean.adoc Updated as part of this pull request.
docs/​src/​modules/​main/​pages/​components/​score-aggregators/​max.adoc Updated as part of this pull request.
docs/​src/​modules/​main/​pages/​components/​score-aggregators/​max-with-bonus.adoc Updated as part of this pull request.
docs/​src/​modules/​main/​pages/​components/​score-aggregators.adoc Updated as part of this pull request.
docs/​src/​modules/​main/​pages/​components/​scanners/​xss.adoc Updated as part of this pull request.
docs/​src/​modules/​main/​pages/​components/​scanners/​url-malicious.adoc Updated as part of this pull request.
docs/​src/​modules/​main/​pages/​components/​scanners/​url-allowlist.adoc Updated as part of this pull request.
docs/​src/​modules/​main/​pages/​components/​scanners/​secrets.adoc Updated as part of this pull request.
docs/​src/​modules/​main/​pages/​components/​scanners/​prompt-injection.adoc Updated as part of this pull request.
docs/​src/​modules/​main/​pages/​components/​scanners/​prompt-injection-protectai.adoc Updated as part of this pull request.
docs/​src/​modules/​main/​pages/​components/​scanners/​pii.adoc Updated as part of this pull request.
docs/​src/​modules/​main/​pages/​components/​scanners/​pii-presidio.adoc Updated as part of this pull request.
docs/​src/​modules/​main/​pages/​components/​scanners/​keyword.adoc Updated as part of this pull request.
docs/​src/​modules/​main/​pages/​components/​scanners/​invisible-text.adoc Updated as part of this pull request.
docs/​src/​modules/​main/​pages/​components/​scanners/​canary-leak.adoc Updated as part of this pull request.
docs/​src/​modules/​main/​pages/​components/​scanners.adoc Updated as part of this pull request.
docs/​src/​modules/​main/​pages/​components/​preprocessors/​whitespace-normalization.adoc Updated as part of this pull request.
docs/​src/​modules/​main/​pages/​components/​preprocessors.adoc Updated as part of this pull request.
docs/​src/​modules/​main/​pages/​components/​loaders/​text-loader.adoc Updated as part of this pull request.
docs/​src/​modules/​main/​pages/​components/​loaders/​file-loader.adoc Updated as part of this pull request.
docs/​src/​modules/​main/​pages/​components/​loaders.adoc Updated as part of this pull request.
docs/​src/​modules/​main/​pages/​components/​custom-components.adoc Updated as part of this pull request.
docs/​src/​modules/​main/​pages/​cli.adoc Updated as part of this pull request.
docs/​src/​modules/​main/​pages/​architecture.adoc Updated as part of this pull request.
docs/​src/​modules/​main/​pages/​additional-information.adoc Updated as part of this pull request.
docs/​src/​modules/​main/​pages/​about.adoc Updated as part of this pull request.
docs/​src/​modules/​main/​nav.adoc Updated as part of this pull request.
docs/​src/​modules/​cerbia/​pages/​index.adoc Updated as part of this pull request.
docs/​src/​modules/​cerbia/​nav.adoc Updated as part of this pull request.
docs/​src/​modules/​cerbia-protectai/​pages/​index.adoc Updated as part of this pull request.
docs/​src/​modules/​cerbia-protectai/​nav.adoc Updated as part of this pull request.
docs/​src/​modules/​cerbia-presidio/​pages/​index.adoc Updated as part of this pull request.
docs/​src/​modules/​cerbia-presidio/​nav.adoc Updated as part of this pull request.
docs/​src/​modules/​cerbia-ml/​pages/​index.adoc Updated as part of this pull request.
docs/​src/​modules/​cerbia-ml/​nav.adoc Updated as part of this pull request.
docs/​src/​modules/​cerbia-core/​pages/​index.adoc Updated as part of this pull request.
docs/​src/​modules/​cerbia-core/​nav.adoc Updated as part of this pull request.
docs/​src/​modules/​cerbia-cli/​pages/​index.adoc Updated as part of this pull request.
docs/​src/​modules/​cerbia-cli/​nav.adoc Updated as part of this pull request.
docs/​src/​antora.yml Updated as part of this pull request.
docs/​source.config.ts Updated as part of this pull request.
docs/​postcss.config.mjs Updated as part of this pull request.
docs/​package.json Updated as part of this pull request.
docs/​next.config.mjs Updated as part of this pull request.
docs/​next-env.d.ts Updated as part of this pull request.
docs/​mdx-components.tsx Updated as part of this pull request.
docs/​lib/​source.ts Updated as part of this pull request.
docs/​layouts/​shared.tsx Updated as part of this pull request.
docs/​layouts/​home.tsx Updated as part of this pull request.
docs/​layouts/​docs.tsx Updated as part of this pull request.
docs/​eslint.config.js Updated as part of this pull request.
docs/​content/​docs/​packages/​meta.json Updated as part of this pull request.
docs/​content/​docs/​packages/​index.mdx Updated as part of this pull request.
docs/​content/​docs/​packages/​cerbia.mdx Updated as part of this pull request.
docs/​content/​docs/​packages/​cerbia-protectai.mdx Updated as part of this pull request.
docs/​content/​docs/​packages/​cerbia-presidio.mdx Updated as part of this pull request.
docs/​content/​docs/​packages/​cerbia-ml.mdx Updated as part of this pull request.
docs/​content/​docs/​packages/​cerbia-core.mdx Updated as part of this pull request.
docs/​content/​docs/​packages/​cerbia-cli.mdx Updated as part of this pull request.
docs/​content/​docs/​meta.json Updated as part of this pull request.
docs/​content/​docs/​index.mdx Updated as part of this pull request.
docs/​content/​docs/​getting-started.mdx Updated as part of this pull request.
docs/​content/​docs/​components/​score-aggregators/​meta.json Updated as part of this pull request.
docs/​content/​docs/​components/​score-aggregators/​mean.mdx Updated as part of this pull request.
docs/​content/​docs/​components/​score-aggregators/​max.mdx Updated as part of this pull request.
docs/​content/​docs/​components/​score-aggregators/​max-with-bonus.mdx Updated as part of this pull request.
docs/​content/​docs/​components/​score-aggregators/​index.mdx Updated as part of this pull request.
docs/​content/​docs/​components/​scanners/​xss.mdx Updated as part of this pull request.
docs/​content/​docs/​components/​scanners/​url-malicious.mdx Updated as part of this pull request.
docs/​content/​docs/​components/​scanners/​url-allowlist.mdx Updated as part of this pull request.
docs/​content/​docs/​components/​scanners/​secrets.mdx Updated as part of this pull request.
docs/​content/​docs/​components/​scanners/​prompt-injection.mdx Updated as part of this pull request.
docs/​content/​docs/​components/​scanners/​prompt-injection-protectai.mdx Updated as part of this pull request.
docs/​content/​docs/​components/​scanners/​pii.mdx Updated as part of this pull request.
docs/​content/​docs/​components/​scanners/​pii-presidio.mdx Updated as part of this pull request.
docs/​content/​docs/​components/​scanners/​meta.json Updated as part of this pull request.
docs/​content/​docs/​components/​scanners/​keyword.mdx Updated as part of this pull request.
docs/​content/​docs/​components/​scanners/​invisible-text.mdx Updated as part of this pull request.
docs/​content/​docs/​components/​scanners/​index.mdx Updated as part of this pull request.
docs/​content/​docs/​components/​scanners/​canary-leak.mdx Updated as part of this pull request.
docs/​content/​docs/​components/​preprocessors/​whitespace-normalization.mdx Updated as part of this pull request.
docs/​content/​docs/​components/​preprocessors/​speculative-decoding.mdx Updated as part of this pull request.
docs/​content/​docs/​components/​preprocessors/​meta.json Updated as part of this pull request.
docs/​content/​docs/​components/​preprocessors/​index.mdx Updated as part of this pull request.
docs/​content/​docs/​components/​meta.json Updated as part of this pull request.
docs/​content/​docs/​components/​loaders/​text-loader.mdx Updated as part of this pull request.
docs/​content/​docs/​components/​loaders/​meta.json Updated as part of this pull request.
docs/​content/​docs/​components/​loaders/​index.mdx Updated as part of this pull request.
docs/​content/​docs/​components/​loaders/​file-loader.mdx Updated as part of this pull request.
docs/​content/​docs/​components/​custom-components/​meta.json Updated as part of this pull request.
docs/​content/​docs/​components/​custom-components/​index.mdx Updated as part of this pull request.
docs/​components/​search-dialog.tsx Updated as part of this pull request.
docs/​components/​mdx/​mermaid.tsx Updated as part of this pull request.
docs/​components/​layout/​theme-toggle.tsx Updated as part of this pull request.
docs/​components/​layout/​search-toggle.tsx Updated as part of this pull request.
docs/​app/​layout.tsx Updated as part of this pull request.
docs/​app/​layout.config.tsx Updated as part of this pull request.
docs/​app/​global.css Updated as part of this pull request.
docs/​app/​docs/​layout.tsx Updated as part of this pull request.
docs/​app/​docs/​[[...slug]]/​page.tsx Updated as part of this pull request.
docs/​app/​api/​search/​route.ts Updated as part of this pull request.
docs/​antora-playbook.yml Updated as part of this pull request.
docs/​antora-playbook.local.yml Updated as part of this pull request.
docs/​.release-version Updated as part of this pull request.
docs/​.gitignore Updated as part of this pull request.
CONTRIBUTING.md Updated as part of this pull request.
.gitignore Updated as part of this pull request.
.github/​workflows/​docs-npm_node-verify.yml Updated as part of this pull request.
.github/​workflows/​docs-npm_node-publish.yml Updated as part of this pull request.
.github/​workflows/​docouture-publish.yml Updated as part of this pull request.
.github/​workflows/​docouture-publish-prerelease.yml Updated as part of this pull request.
.github/​workflows/​docouture-pr-verify.yml Updated as part of this pull request.
.github/​workflows/​docouture-kroki-cache-warm.yml Updated as part of this pull request.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread .github/workflows/docouture-publish-prerelease.yml
Comment thread README.md Outdated
@github-actions

Copy link
Copy Markdown
Contributor

❗ This Pull Request will not trigger a docs release

A Pull Request with no docs/release label will not trigger a docs site release — label it docs/release if you want this merge to release the docs site.

@github-actions

Copy link
Copy Markdown
Contributor

Release Preview

This pull request has the skip-release label and will not create a Python release.

@sonarqubecloud

Copy link
Copy Markdown

@sergiobe-itx
sergiobe-itx merged commit 421dfae into main Sep 30, 2026
24 checks passed
@sergiobe-itx
sergiobe-itx deleted the feature/migrate-docs-to-docouture branch October 13, 2026 07:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

skip-release Do not publish a release for this change.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants