Document structure, responsibilities, and entry points per-directory #68
Conversation
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
q-inho
force-pushed
the
dev/python_impl/readme
branch
2 times, most recently
from
fc7a570 to
f6f8177
Compare
…ME.md files for H-hat Core, Code IR, Compiler, Data, Error Handlers, Execution, Imports, Low-level Backends, Memory, and Types to enhance clarity and detail.
…acy AST references
q-inho
force-pushed
the
dev/python_impl/readme
branch
from
f6f8177 to
6fded76
Compare
…r overview, purpose, subsystem layout, and processing flow sections.
…verview, purpose, scope, core concepts, and processing flow sections.
…er overview, purpose, architectural role, processing flow, and integration points.
…verview, purpose, scope, core concepts, and processing flow sections.
…verview, purpose, design overview, structural units, symbol and reference tables, program graph, instruction model, and utilities.
…rs overview, purpose, design overview, error taxonomy, interaction with core subsystems, and usage pattern sections.
…yer overview, purpose, scope, core concepts, execution model, IR graph management, memory and scope discipline sections.
… overview, purpose, scope, core concepts, processing flow, resource and scope discipline, function entry and return, and quantum index lifecycle sections.
…r overview, purpose, project layout assumptions, name to path mapping, loading and graph interaction, type resolution, function resolution, reference table construction, and file inventory sections.
…ckends overview, purpose, context and scope, abstraction model, interface contract, processing flow, resource and index discipline, error model and results, and file inventory sections.
…overview, purpose, scope, core concepts, structural families, built-in catalog and conversion, size resolution, and file inventory sections.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 documents the Python implementation of H-hat by adding
README.mdfiles to key directories. Each README explains the folder’s purpose, main modules, typical call paths, and where to start when extending or testing. This aims to lower onboarding time and make the codebase easier to navigate for contributors.Checklist
Package root
python/src/hhat_lang/README.mdCore
python/src/hhat_lang/core/README.mdpython/src/hhat_lang/core/code/README.mdpython/src/hhat_lang/core/compiler/README.mdpython/src/hhat_lang/core/data/README.mdpython/src/hhat_lang/core/error_handlers/README.mdpython/src/hhat_lang/core/execution/README.mdpython/src/hhat_lang/core/imports/README.mdpython/src/hhat_lang/core/lowlevel/README.mdpython/src/hhat_lang/core/memory/README.mdpython/src/hhat_lang/core/types/README.mdDialects
python/src/hhat_lang/dialects/heather/README.mdpython/src/hhat_lang/dialects/heather/code/README.mdpython/src/hhat_lang/dialects/heather/code/mlir_builder/README.mdpython/src/hhat_lang/dialects/heather/code/simple_ir_builder/README.mdpython/src/hhat_lang/dialects/heather/code/ssa_ir_builder/README.mdpython/src/hhat_lang/dialects/heather/execution/README.mdpython/src/hhat_lang/dialects/heather/execution/classical/README.mdpython/src/hhat_lang/dialects/heather/execution/quantum/README.mdpython/src/hhat_lang/dialects/heather/grammar/README.mdpython/src/hhat_lang/dialects/heather/parsing/README.mdpython/src/hhat_lang/dialects/heather/toolchain/README.mdpython/src/hhat_lang/dialects/heather/toolchain/notebooks/README.mdpython/src/hhat_lang/dialects/heather/toolchain/pygments/README.mdpython/src/hhat_lang/dialects/heather/toolchain/pygments/lexer/README.mdLow level
python/src/hhat_lang/low_level/README.mdpython/src/hhat_lang/low_level/quantum_lang/README.mdpython/src/hhat_lang/low_level/quantum_lang/net_qasm/README.mdpython/src/hhat_lang/low_level/quantum_lang/openqasm/v2/README.mdpython/src/hhat_lang/low_level/target_backend/README.mdpython/src/hhat_lang/low_level/target_backend/qiskit/README.mdpython/src/hhat_lang/low_level/target_backend/qiskit/openqasm/README.mdpython/src/hhat_lang/low_level/target_backend/squidasm/README.mdToolchain
python/src/hhat_lang/toolchain/README.mdpython/src/hhat_lang/toolchain/cli/README.mdpython/src/hhat_lang/toolchain/notebooks/README.mdpython/src/hhat_lang/toolchain/project/README.md