Skip to content

Repository files navigation

ccompactor documentation site

The site published at https://ccompactor.github.io/.

React + Vite, no framework beyond that: the whole site is one page, and the content lives in src/content.js so docs can be edited without touching layout code.

npm install
npm run dev       # http://localhost:5173/
npm run build     # -> dist/
npm run preview

Deployment

The site is its own repository — ccompactor/ccompactor.github.io — which builds and deploys itself on push, so nothing in the CLI repository needs to change when the site does. Nothing is committed from dist/; it is built in CI.

vite.config.js sets base: "/" because the site is served as a GitHub Pages user site, at the domain root. Publishing it from a repository subpath instead means changing that to "/<repo>/".

Editing the docs

File What it holds
src/content.js every heading, paragraph, table, command, and example
src/App.jsx layout and the section renderers
src/styles.css the visual language: safety yellow on blacktop, hazard stripes, monospace for commands
src/assets/img/ccompactor-logo.png the mark, used in the header, the hero, and the footer
public/favicon.png, public/apple-touch-icon.png 64px and 192px derivatives of the logo, generated with sips -Z 64 and sips -Z 192

Each section carries a text field used by the search box, so add keywords there when you add a section.

When the CLI changes, src/content.js and the skill payload under packages/ccompactor/skill/ both need updating — they are the two places that document flags.

House style

Every factual claim on this site is true of the current build. The one number that is not flattering — ccompactor's retrieval accuracy against its Rust sister project — is published in the Benchmarks section, in a caution ribbon, on purpose. Do not soften it and do not remove it.

About

Website for ccompactor — extract any coding-agent session into a handoff any other agent can continue from.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages