Skip to content

Commit e422d66

Browse files
committed
Add CLAUDE.md
1 parent b1cf22c commit e422d66

1 file changed

Lines changed: 61 additions & 0 deletions

File tree

CLAUDE.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# CLAUDE.md
2+
3+
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
4+
5+
## Repository Overview
6+
7+
This is an IETF Internet-Draft repository for Media over QUIC (MOQ) protocol specifications authored by Luke Curley. It contains three draft documents:
8+
9+
- **draft-lcurley-moq-lite.md**: A simplified MOQ transport protocol for real-time conferencing
10+
- **draft-lcurley-moq-hang.md**: Specification for handling connection hangs in MOQ
11+
- **draft-lcurley-moq-use-cases.md**: MOQ protocol use cases documentation
12+
13+
## Build Commands
14+
15+
```bash
16+
# Build all drafts (generates HTML and text versions)
17+
make
18+
19+
# Clean build artifacts
20+
make clean
21+
22+
# Update GitHub Pages (typically done via CI)
23+
make gh-pages
24+
```
25+
26+
## Development Workflow
27+
28+
1. **Prerequisites**: The build system requires i-d-template tools. See [setup instructions](https://github.com/martinthomson/i-d-template/blob/main/doc/SETUP.md).
29+
30+
2. **Building drafts**: Running `make` will:
31+
- Initialize the i-d-template submodule if needed
32+
- Convert Markdown drafts to RFC XML format
33+
- Generate HTML and text versions
34+
- Output files: `draft-*.html` and `draft-*.txt`
35+
36+
3. **Git workflow**:
37+
- Main branch: `main`
38+
- Pull requests automatically trigger CI builds
39+
- GitHub Pages updates on push to main
40+
41+
## Architecture
42+
43+
This is a standards documentation project, not a software implementation. Key components:
44+
45+
- **Draft documents**: Root-level `draft-*.md` files in kramdown-rfc format
46+
- **Build system**: Uses i-d-template via git submodule in `lib/`
47+
- **CI/CD**: GitHub Actions workflows handle building and publishing
48+
- **Output**: Published to GitHub Pages at https://kixelated.github.io/moq-drafts/
49+
50+
## Working Group Context
51+
52+
- Part of IETF Media Over QUIC (MOQ) Working Group
53+
- Discussion: moq@ietf.org mailing list
54+
- Related to main MoqTransport specification (moq-lite is a simplified alternative)
55+
56+
## Important Notes
57+
58+
- Follow IETF contribution guidelines (BCP 78/79)
59+
- Draft format uses kramdown-rfc with YAML frontmatter
60+
- References are managed via bibxml includes
61+
- Do not edit generated files (*.html, *.txt)

0 commit comments

Comments
 (0)