Skip to content

docs: CLAUDE.md — build, layout and invariants for Claude Code - #68

Merged
widgetii merged 1 commit into
masterfrom
docs/claude-md
Oct 23, 2026
Merged

widgetii merged 1 commit into
masterfrom
docs/claude-md

Conversation

@widgetii

Copy link
Copy Markdown
Member

Adds CLAUDE.md, guidance for Claude Code in this repository, rewritten for the current tree: the one vectis binary (the former vectis-cli), the -U usbfs transport (usbserial.c, ch34x.c), vectis-bootrom.c as reference, the regression tests and warning gate, the -l raw/RFC 2217 auto-detection, the RTS/DTR contract of -u vs -U, and the version check / latest release flow.

Markdown only, so no new PROGRAM_VERSION is needed (check-version.sh locally: "version 1.9.0 unchanged, no code or build changes"). Local check: make with no warnings, python3 tests/test_vectis.py . all passed.

Brought up to date with the current tree: one vectis binary (the former
vectis-cli) with -u/-U/-h/-p, -l and -w; usbserial.c + ch34x.c for -U;
vectis-bootrom.c kept for reference. Covers the regression tests, the
warning gate, the -l raw/RFC 2217 auto-detection, the RTS/DTR contract of
-u vs -U, and the version check and latest-release flow.
@qodo-free-for-open-source-projects

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Grey Divider

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

Grey Divider

Tip of the day
💡 Did you know, you can reply 'qodo' on any finding to push back, ask questions, or dig deeper

More tips ↗ | Customize Qodo ↗ | Qodo docs ↗

Grey Divider

Qodo Logo

@qodo-free-for-open-source-projects

Copy link
Copy Markdown

PR Summary by Qodo

Document build, repository layout, and invariants for Claude Code

📝 Documentation 🕐 Less than 10 minutes

Grey Divider

AI Description

• Add Claude Code guidance for building, testing, and navigating the current repository.
• Record transport and RFC 2217 invariants to help prevent behavioral regressions.
• Explain version checks and the release flow for future changes.
Diagram

graph TD
  Guide["CLAUDE.md"] --> Build["Make build"] --> Vectis["vectis binary"] --> USB["usbserial transport"] --> Chip["ch34x driver"]
  Guide --> Tests["Regression tests"]
  Guide --> Release["Release checks"]
Loading
High-Level Assessment

A dedicated CLAUDE.md is appropriate for agent-specific repository guidance. Putting these instructions in the user-facing READMEs would mix contributor workflow with product documentation; no architectural change is needed.

Files changed (1) +93 / -0

Documentation (1) +93 / -0
CLAUDE.mdAdd Claude Code repository and maintenance guide +93/-0

Add Claude Code repository and maintenance guide

• Documents build and regression-test commands, the current vectis and USB transport layout, and behavior-sensitive RFC 2217, stdin, modem-line, and bootrom contracts. Also explains version-bump requirements and the latest-release workflow. No runtime or build files change.

CLAUDE.md

@widgetii
widgetii merged commit 9c67a0f into master Oct 23, 2026
25 of 29 checks passed
@widgetii
widgetii deleted the docs/claude-md branch October 23, 2026 12:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant