Skip to content

docs: free documentation site (Docusaurus on GitHub Pages)#31

Merged
RodCor merged 9 commits into
mainfrom
feat/docs-site
Jun 23, 2026
Merged

docs: free documentation site (Docusaurus on GitHub Pages)#31
RodCor merged 9 commits into
mainfrom
feat/docs-site

Conversation

@RodCor

@RodCor RodCor commented Jun 23, 2026 •
edited
Loading

Copy link
Copy Markdown
Owner

Free documentation site (Docusaurus, GitHub Pages)

Sets up a free hosted docs site at https://rodcor.github.io/kimetsu/, deployed
from main via GitHub Actions.

What's here

  • Docusaurus 3 site in website/ with a Kimetsu-branded landing page (hero,
    the verified metrics, install command, GitHub link) and the full public docs.
  • Single-sourced content. docs/ + README.md + CHANGELOG.md stay the
    only source of truth. website/scripts/sync-docs.mjs regenerates the site
    content from an explicit allowlist on every build (prebuild hook), so the
    published site never drifts from the docs.
  • Deploy workflow (.github/workflows/docs.yml): builds on push to main
    (paths docs/**, website/**, README.md, CHANGELOG.md) and publishes via
    the official GitHub Pages Actions flow. Nothing deploys until this merges.

One-time setup (already done)

Repo Settings -> Pages -> Source = "GitHub Actions".

Notes

  • website/node_modules, website/build, and the generated docs-site-content/
    are gitignored.
  • npm run build verified green locally.

RodrigoCordoba and others added 9 commits June 22, 2026 20:51
@RodrigoCordoba @claude
docs(readme): promo polish — tighten voice, metrics in own section, i…
badee4e 
…nstall-only quickstart

- Drop the 'At a glance' block; move metrics to a dedicated Benchmarks section
  after How it works; remove the configurable-surface table (it lives in the docs)
- Remove per-feature version tags from Why Kimetsu; keep the demon-slayer line up top
- Quickstart is install-only; all other commands move to a Command reference table
- Simplify What's in the box to the core components
- Remove em-dashes throughout; shrink the demo gif (920 -> 720)

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@RodrigoCordoba @claude
docs(site): scaffold Docusaurus 3 site for GitHub Pages at /kimetsu/
1665689 
- website/: Docusaurus 3 (classic JS template), configured for
  https://rodcor.github.io/kimetsu/. Blog disabled. markdown.format=detect
  so .md files parse as lenient CommonMark (handles README's div/img HTML).
- docs-site-content/: curated public docs with front-matter — intro (from
  README), HOW-KIMETSU-WORKS, INSTALL, LOCAL-MODELS, REMOTE, ROI-METHODOLOGY,
  CONTRIBUTING, CODE_OF_CONDUCT, CHANGELOG. Explicit sidebar allowlist;
  docs/superpowers/ is never referenced.
- .github/workflows/docs.yml: GH Pages deploy on push to main (docs/**,
  website/**, README.md, CHANGELOG.md) via actions/configure-pages@v5 +
  upload-pages-artifact@v3 + deploy-pages@v4.
- .gitignore: exclude website/node_modules/, website/build/, website/.docusaurus/.
- Fixed 3 broken cross-doc links (HOW-KIMETSU-WORKS.md -> slug, ../npm -> abs URL).
- Build verified: npm run build exits 0, zero superpowers/roadmap content in build/.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@RodrigoCordoba @claude
docs(site): single-source the docs content (generate, don't copy)
0617c16 
The initial scaffold committed static copies of the docs into docs-site-content/,
which would silently drift from the canonical docs/. Replace with a generated
flow:
- website/scripts/sync-docs.mjs regenerates docs-site-content/ from an explicit
  allowlist (README, CHANGELOG, the 7 public docs/) with front-matter + link
  rewrites. The allowlist is the only thing ever published, so docs/superpowers/
  can never leak.
- npm prebuild/prestart hooks run the sync, so build/start always reflect docs/.
- docs-site-content/ is now gitignored (generated); untracked the copies.
- Workflow drops the docs-site-content path trigger; build regenerates from
  docs/**, README.md, CHANGELOG.md.

Verified: npm run build exits 0; build/ contains zero docs/superpowers content.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@RodrigoCordoba @claude
docs(site): landing polish — remove em-dash, drop dead scaffold
2ed8d5a 
- Fix the one em-dash in the homepage feature copy (no-em-dash house style)
- Remove unused scaffold (HomepageFeatures component, sample markdown-page.mdx)
- Build verified green

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@RodrigoCordoba @claude
docs(site): redesign landing — warm-dark theme, red accent, tighter type
b9df7aa 
- Dark default (Claude-Code 'dark compass' aesthetic): warm near-black surface
  stack, red accent (#ef5b60 dark / #cf3a40 light) replacing the orange/green.
- Drop the solid hero--primary banner (a full-accent block read as 'rough') for
  a dark hero with red used only as accent (title highlight, prompt, CTA).
- Tighten the type scale (hero 3.5rem -> 2.6rem, h1 2rem); 16px body, 1.65 line
  height; monospace tabular figures for the metrics row.
- Cleaner bordered cards, single-weight dividers, reduced-motion handling.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@RodrigoCordoba @claude
docs(site): smaller docs typography + larger hero logo
4bfbe5b 
- Scope a denser type scale to doc pages (~14px body, h1 1.5rem, h2 1.2rem,
  matched sidebar + TOC); landing unaffected.
- Double the hero logo (64 -> 128px; 96px on mobile).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@RodrigoCordoba @claude
docs(site): warm near-black footer (was slate-blue)
6849165 
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@RodrigoCordoba @claude
fix(deps): bump quinn-proto 0.11.14 -> 0.11.15 (RUSTSEC-2026-0185)
0447a5a 
Patches a remote memory-exhaustion advisory in quinn-proto's out-of-order
stream reassembly (transitive dep via the remote QUIC/TLS stack). Lockfile-only
bump; kimetsu-remote checks clean. Clears the failing cargo-audit CI gate.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@RodrigoCordoba @claude
fix(projector): deterministic event replay order (ts, rowid)
c8eba83 
The rebuild replay ordered events by (ts, event_id). event_id is a ULID whose
ordering is only random-tail-stable within a millisecond, so events sharing a
	s replayed in a platform-dependent order. This made rebuilds
non-deterministic: e.g. a memory.cited (citation -> member) and the
memory.superseded that reassigns it to the survivor could replay in either
order, leaving the citation on the retired member. Surfaced as a flaky
consolidation_is_rebuild_safe failure on the macOS CI runner.

Order by (ts, rowid) instead: rowid is insertion-monotonic, so equal-ts events
replay in append (causal) order. Deterministic across platforms.

Gates: fmt + clippy (lean + embeddings) + cargo test --workspace all green;
the previously-flaky test passes 5/5 locally.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@RodCor
RodCor merged commit 68f9ae4 into main Jun 23, 2026
14 checks passed
@RodCor
RodCor deleted the feat/docs-site branch June 23, 2026 19:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@RodCor @RodrigoCordoba