You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
58 lines
1.5 KiB
Markdown
58 lines
1.5 KiB
Markdown
@../CLAUDE.md
|
|
|
|
# CLAUDE.md — edu
|
|
|
|
<working-directory>
|
|
All commands in this file are run from the `edu/` directory.
|
|
</working-directory>
|
|
|
|
<project-overview>
|
|
|
|
## What This Project Is
|
|
|
|
`edu` is an [mdbook](https://rust-lang.github.io/mdBook/)-based static site called **Vibed Learning** — a collection of self-guided courses and technical references. There is no Rust code here; all content is Markdown. The generated `book/` directory is gitignored.
|
|
|
|
</project-overview>
|
|
|
|
<commands>
|
|
|
|
## Commands
|
|
|
|
```sh
|
|
# Build the static site
|
|
mdbook build
|
|
|
|
# Serve locally with live reload (default: http://localhost:3000)
|
|
mdbook serve
|
|
|
|
# Enter the Nix dev shell (provides mdbook + nbd)
|
|
nix develop
|
|
# or automatically via direnv: cd into the directory
|
|
```
|
|
|
|
</commands>
|
|
|
|
<content-structure>
|
|
|
|
## Content Structure
|
|
|
|
- `src/SUMMARY.md` — mdbook table of contents; controls site navigation. **Every new page must be listed here.**
|
|
- `src/<page>.md` — individual course or reference pages
|
|
- `book.toml` — site title, theme (navy), and source directory
|
|
|
|
To add a new page: create `src/<name>.md`, then add it to `src/SUMMARY.md` under the appropriate section heading.
|
|
|
|
</content-structure>
|
|
|
|
<conventions>
|
|
|
|
## Conventions
|
|
|
|
Scope for commit messages: `edu` (e.g., `docs(edu): write §3 transition matrices`).
|
|
|
|
Ticket IDs appear in commit messages in `[<id>]` format.
|
|
|
|
Stub sections in content are marked with 🚧 and reference an nbd ticket — fill in content and close the ticket when complete.
|
|
|
|
</conventions>
|