Skip to content

docs: add a docs site for GitHub Pages - #95

Merged
spydisec merged 1 commit into
mainfrom
docs/site
Nov 12, 2026
Merged

spydisec merged 1 commit into
mainfrom
docs/site

Conversation

@spydisec

Copy link
Copy Markdown
Owner

Summary: Add a small docs site that is built from the Markdown files already in the repo, and a workflow that publishes it to GitHub Pages.

Changes:

  • site/build.sh copies the README, docs/guide.md, docs/integrations/ and rules/README.md into a build folder, rewrites the links between them, and runs MkDocs Material with --strict. Links to other repo files point to GitHub.
  • .github/workflows/pages.yml builds the site on a pull request that touches those files, and publishes it from main. The site also serves the get.sh of the latest release, after checking it against SHA256SUMS.
  • The release workflow starts a pages run after it publishes, so the site gets the new get.sh.
  • CI routing: a change under site/ selects lint only.

After the merge: turn on Pages for the repo with GitHub Actions as the source. The custom domain is a later change.

Note: Material for MkDocs gets fixes until May 2027. Its successor, Zensical, reads the same mkdocs.yml.

site/build.sh builds the site with MkDocs Material from the README,
docs/guide.md, docs/integrations/ and rules/README.md, so no page is
written twice. The site also serves the get.sh of the latest release.

The pages workflow builds the site on a pull request and publishes it
from main. The release workflow starts a run after each release.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Nov 12, 2026

Copy link
Copy Markdown
Contributor

Important

  • Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: f1cab312-9675-403c-97bc-834786b8391b
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

Share

@spydisec
spydisec merged commit a181ab8 into main Nov 12, 2026
32 checks passed
@spydisec
spydisec deleted the docs/site branch November 12, 2026 02:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant