No description
Find a file
2026-05-01 07:32:26 -04:00
.opencode/rules docs: add source verification rules to AGENTS.md and .opencode/rules 2026-04-27 23:58:31 -04:00
.vale/config/vocabularies/vocab refactor: remove obsolete rumdl-disable comments 2026-05-01 06:27:45 -04:00
resources/transcripts feat(resources): add video transcript files 2026-03-18 08:36:25 -04:00
scripts feat: add self-modifying software entry with Pi story 2026-05-01 07:13:31 -04:00
src fix: disable MD013 for reference files, wrap long transcript line 2026-05-01 07:32:26 -04:00
theme feat: add plausible header 2026-03-24 22:07:39 -04:00
.env.example chore: add a example env file to demonstrate needed variables 2026-03-24 22:06:42 -04:00
.gitignore chore(deploy): secure Pi credentials in .env file for safe public repo 2026-03-24 21:20:55 -04:00
.rumdl.toml chore: add dprint formatter and reorganize index files 2026-03-27 09:06:10 -04:00
.vale.ini fix: disable MD013 for reference files, wrap long transcript line 2026-05-01 07:32:26 -04:00
AGENTS.md docs: add source verification rules to AGENTS.md and .opencode/rules 2026-04-27 23:58:31 -04:00
book.toml fix: remove linkcheck2 output renderer to restore book/ structure; add link-check command 2026-03-27 22:44:03 -04:00
cog.toml feat: migrate to new cog.toml format 2026-03-27 21:39:45 -04:00
dprint.json chore: add dprint formatter and reorganize index files 2026-03-27 09:06:10 -04:00
justfile fix: remove linkcheck2 output renderer to restore book/ structure; add link-check command 2026-03-27 22:44:03 -04:00
lefthook.yml feat: add deterministic quote verification guardrail in Rust 2026-04-28 00:07:26 -04:00
README.md docs: update README with Vale and cocogitto dependencies 2026-03-27 20:56:32 -04:00

Developer Wisdom

A commonplace book of software engineering wisdom, built with mdbook.

Dependencies

Install these tools to build and work on this project:

Tool Purpose Install
mdbook Build the book cargo install mdbook
dprint Format markdown cargo install dprint
rumdl Lint markdown cargo install rumdl
lefthook Git hooks brew install lefthook
cocogitto Validate commits cargo install cocogitto
vale Grammar linting brew install vale
just Run commands brew install just or cargo install just
rsync Deploy to server Built-in on macOS/Linux

Getting Started

# Install dependencies
cargo install mdbook dprint rumdl cocogitto just
brew install lefthook vale

# Install git hooks
lefthook install

# Build the book
just build

# Serve locally
just serve

# Format markdown
just fmt

# Check formatting (CI)
just fmt-check

# Lint markdown
rumdl check src/

# Lint prose (grammar, style)
vale src/

Project Structure

  • src/ - Markdown source files
  • book/ - Built output (gitignored)
  • dprint.json - Markdown formatter config
  • lefthook.yml - Git hook config
  • .rumdl.toml - Markdown linter config
  • justfile - Build and deploy commands
  • AGENTS.md - Guidelines for AI agents

Deploy

just deploy

Requires server credentials in .env file.