Skip to content

Commit b63a1f8

Browse files
committed
Add a CLAUDE.md file
1 parent 898a6ed commit b63a1f8

1 file changed

Lines changed: 48 additions & 0 deletions

File tree

CLAUDE.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# CLAUDE.md
2+
3+
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
4+
5+
## Project Overview
6+
7+
This repository contains the HALPI2 User Guide documentation, built with mdBook. HALPI2 is a Raspberry Pi Compute Module 5 carrier board designed for marine electronics and industrial applications.
8+
9+
## Build System
10+
11+
**Prerequisites:** Rust and Cargo must be installed. Then install mdBook:
12+
```bash
13+
cargo install mdbook
14+
```
15+
16+
**Common Commands:**
17+
- `mdbook build` - Build the documentation (output goes to `./book`)
18+
- `mdbook serve --open` - Start local dev server and open in browser
19+
- `mdbook test` - Test code samples in the documentation
20+
- `mdbook clean` - Remove the build directory
21+
22+
## Documentation Structure
23+
24+
- `src/SUMMARY.md` - Table of contents (mdBook navigation structure)
25+
- `src/` - All markdown content organized by section:
26+
- `getting-started/` - Quick start and installation guides
27+
- `user-guide/` - System operation, hardware, interfaces, software
28+
- `technical-reference/` - Detailed hardware specs and technical docs
29+
- `software-development/` - Daemon, integration, Ubuntu installation
30+
- `appendices/` - Design files, schematics, errata
31+
- `theme/` - Custom CSS/JS for page TOC functionality
32+
- `book.toml` - mdBook configuration
33+
34+
## Documentation Status
35+
36+
Check `src/SUMMARY.md` for completion status of each page (✅ = complete, ❌ = incomplete/placeholder).
37+
38+
## Deployment
39+
40+
GitHub Actions automatically builds and deploys to GitHub Pages on push to `main` branch. See `.github/workflows/mdbook.yml`.
41+
42+
## Content Guidelines
43+
44+
- Use GitHub-flavored Markdown
45+
- Include images with descriptive alt text
46+
- Cross-reference other pages using relative paths
47+
- Technical specs and measurements should be in the technical-reference section
48+
- Step-by-step instructions belong in getting-started or user-guide sections

0 commit comments

Comments
 (0)