rajdeepratanrajdeepratan/SlashForge/docs/CLAUDE.md

SlashForge

CLAUDE.md5 starsChanged 35 days agoMITView on GitHub

The documentation site for SlashForge — a standalone Astro workspace nested in the kit repo. It has its own dependencies, build, and CI checks, separate from the root CLI. See the repo root CLAUDE.md for the kit as a whole. git and code-reviewer are global agents at the repo root and are inherited — do not re-list them here. Doc-check scripts (run from docs/ after a build):

In this repository3 other files it gives its agents.
- CLAUDE.mdCLAUDE.md
- add-commandSkill
- add-guide-fileSkill

The file

We split this CLAUDE.md into the rules it gives an agent

4 rules. About 0 are common, 0 are distinctive, and 4 are very specific to this project.

≈0
Common · estimate
Many files like this have a rule of this kind.
≈0
Distinctive · estimate
This author's own choices. Worth a look.
4
Very specific
Tied to their project's names, files or tools. Probably skip.

Common
Distinctive
Very specific

Very specific:
Never hand-write the version into a page.
line 75
Very specific:
Don't commit a macOS-only package-lock.json — CI's npm ci needs the Linux optional deps.
line 76
Very specific:
After editing src/plugins/, clear docs/node_modules/.astro and docs/.astro if the change doesn't take effect.
line 77
Very specific:
Keep the site passing every check-docs-* script — Astro won't fail a dead in-page link on its own.
line 78

≈ “Common” is an estimate: at least 1 in 5 of the 26,980 CLAUDE.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.

Files

CLAUDE.md

slashforge-docs

The documentation site for SlashForge — a standalone Astro workspace nested in the kit repo. It has its own dependencies, build, and CI checks, separate from the root CLI. See the repo root CLAUDE.md for the kit as a whole.

Agent orchestration

When the user says...	Invoke
"investigate", "reproduce this", "root-cause"	`/slashforge-investigate`
"build", "add a page", "change the docs", "fix Y"	`/slashforge-code`
"small change", "tiny fix", "one-liner"	`/slashforge-code -quick`
"docs page", "component", "styling", "build the site" (mid-task)	`docs-developer`
anything else	`developer`

git and code-reviewer are global agents at the repo root and are inherited — do not re-list them here.

Project References

Type	File
Rule	`docs/.claude/rules/astro-docs.md`
Agent	`docs/.claude/agents/docs-developer.md`

Tech stack

Concern	Choice
Framework	Astro 7 (`astro`)
Module system	ESM (`"type": "module"`)
Search	pagefind
Fonts	`@fontsource-variable/archivo`, `@fontsource-variable/jetbrains-mono`
Markdown	`@astrojs/markdown-remark`, `remark-directive`, `unist-util-visit`
Node	24 (Astro 7 needs ≥ 22.12)

Commands (run from `docs/`)

npm ci            # install (CI uses this)
npm run dev       # dev server (runs sync:changelog first)
npm run build     # production build (sync:changelog → astro build → pagefind)
npm run preview   # preview the built site

Doc-check scripts (run from docs/ after a build):

node ../.github/scripts/check-docs-links.mjs
node ../.github/scripts/check-docs-targets.mjs
node ../.github/scripts/check-docs-width.mjs
node ../.github/scripts/check-docs-a11y.mjs
node ../.github/scripts/check-docs-facts.mjs

Project structure

docs/
├─ astro.config.mjs        # Astro config
├─ src/
│  ├─ content/             # doc pages (changelog.md is GENERATED — don't edit)
│  ├─ components/          # UI components
│  ├─ plugins/             # build-time remark/rehype plugins (clear .astro cache after edits)
│  ├─ layouts/  pages/  styles/  assets/  scripts/
├─ scripts/                # sync-changelog.mjs, root-redirect.mjs
└─ public/                 # static assets

Non-negotiable rules

The changelog page is generated from the repo-root CHANGELOG.md at build time — never edit or commit docs/src/content/docs/changelog.md.
Never hand-write the version into a page; it's derived from package.json (check-docs-facts.mjs).
Don't commit a macOS-only package-lock.json — CI's npm ci needs the Linux optional deps. See docs/.claude/rules/astro-docs.md.
After editing src/plugins/, clear docs/node_modules/.astro and docs/.astro if the change doesn't take effect.
Keep the site passing every check-docs-* script — Astro won't fail a dead in-page link on its own.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

It worked
Partly
It didn't

What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free