ZIR-000: Add comprehensive architecture and development documentation#331
Open
ZIR-000: Add comprehensive architecture and development documentation#331
Conversation
Add comprehensive documentation for the ZIR-XXX: commit format standard. This includes: - CONTRIBUTING.md with quick reference and setup instructions - docs/commit-guidelines.md with detailed guidelines and examples - Documentation of existing commit-msg hook and template infrastructure The repository already has validation tooling in place (.git/hooks/commit-msg and .git/commit-msg-template). This commit adds missing documentation to help all contributors understand and follow the standardized format. Nightshift-Task: commit-normalize Nightshift-Ref: https://github.com/marcus/nightshift
Adds tracked versions of commit-msg hook and template in hooks/ directory, along with setup script to install them. Updates documentation to guide contributors through setup process. Changes: - Add hooks/commit-msg and hooks/commit-msg-template - Add scripts/setup-git-hooks.sh for automated setup - Update CONTRIBUTING.md with setup instructions - Update README.md with contributing section Nightshift-Task: commit-normalize Nightshift-Ref: https://github.com/marcus/nightshift
Make hooks/commit-msg executable (100755) to match setup script. While the setup script does chmod +x after copying, tracking the file as executable in git is better practice. Nightshift-Task: commit-normalize Nightshift-Ref: https://github.com/marcus/nightshift
Create four new documentation files to help developers understand the Zirgen compiler structure and development workflow: - ARCHITECTURE.md: Compiler structure, MLIR dialects, and codegen pipeline - docs/BAZEL_BUILD_GUIDE.md: Build system guide with common patterns - docs/SCRIPTS_REFERENCE.md: Documentation for development scripts - docs/CODE_NAVIGATION.md: Guide to navigating the codebase Also updated README.md and zirgen/docs/README.md to link to the new developer documentation. These docs complement the existing user-facing circuit language documentation by providing architectural overview and practical development guidance for compiler contributors. Nightshift-Task: docs-backfill Nightshift-Ref: https://github.com/marcus/nightshift
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds comprehensive developer documentation to help contributors understand the Zirgen compiler architecture and development workflow. The new documentation complements the existing user-facing circuit language guides.
New Documentation Files
Changes to Existing Files
Key Topics Covered
Documentation Organization
The new docs are organized to support different use cases:
Test plan
🤖 Generated with Claude Code