Better directory structure for docs - reorganize documentation and streamline README#20
Better directory structure for docs - reorganize documentation and streamline README#20
Conversation
…mline README.md Co-authored-by: helium729 <30749877+helium729@users.noreply.github.com>
|
Add documentations for other supported extensions like M and Zicsr, also write about interrupts @copilot |
…dling Co-authored-by: helium729 <30749877+helium729@users.noreply.github.com>
Added comprehensive documentation for M extension, Zicsr extension, and interrupt handling. Created:
All documentation includes implementation details, configuration examples, and programming guidance. Commit: c05e676 |
There was a problem hiding this comment.
Pull Request Overview
This PR reorganizes the project's documentation by introducing a structured docs/ directory, relocating existing documentation files into appropriate subdirectories, and condensing the root README.md to focus on key information.
- Created a clear directory layout under
docs/with subdirectories for architecture, extensions, and testing - Moved legacy documentation files into the new
docs/hierarchy - Streamlined the top-level
README.mdand added a dedicateddocs/README.mdas an entry point
Reviewed Changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/testing/simulation.md | Updated step wording to refer to the project root directory |
| docs/extensions/zicsr-extension.md | Added detailed Zicsr extension implementation document |
| docs/extensions/m-extension.md | Added detailed M extension implementation document |
| docs/architecture/overview.md | Added high-level processor architecture overview |
| docs/architecture/interrupts.md | Added comprehensive interrupt handling documentation |
| docs/README.md | Created documentation index with links to subdirectories |
| README.md | Condensed root README and updated integration examples |
Comments suppressed due to low confidence (3)
docs/README.md:12
- [nitpick] The term 'Compact instruction extension' could be misleading. Consider using 'Compressed instruction extension' to align with the official RISC-V naming for the C extension.
- [C Extension](extensions/c-extension.md) - RISC-V Compact instruction extension support
README.md:39
- [nitpick] The '+Zicsr' label in the configuration table may be ambiguous; consider renaming it to 'Zicsr Extension' or integrating it as a column header for clarity.
| +Zicsr | Any | Any | Any | Any | ✓ |
README.md:106
- The port name '.reset' does not match the earlier interface which uses '.resetn'. Update this to '.resetn(resetn)' to match the actual signal name.
.reset(reset),
This PR addresses the documentation organization issues identified in the repository by creating a proper directory structure and streamlining the root README.md.
Changes Made
📁 Created organized documentation structure
docs/directory with logical subdirectories:docs/architecture/- Architecture and design documentationdocs/extensions/- Extension-specific documentationdocs/testing/- Test guides and references📝 Moved scattered documentation files
COMPLETE_PROGRAM_TESTS.md→docs/testing/complete-program-tests.mdCONFIGURATION_TESTING.md→docs/testing/configuration-testing.mdC_EXTENSION.md→docs/extensions/c-extension.mdTESTS.md→docs/testing/instruction-tests.mdsim/README.md→docs/testing/simulation.md🎯 Streamlined root README.md
📋 Added documentation navigation
docs/README.mdas documentation indexdocs/architecture/overview.mdwith detailed processor architectureBefore & After
Before: Documentation scattered across root directory, 276-line README with excessive detail obscuring the project's purpose
After: Clean root directory with organized docs structure, concise README focusing on architecture and getting started
Repository Structure
The documentation now provides a much clearer entry point for users while maintaining all detailed information in an organized, discoverable structure.
Fixes #19.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.