refactor: Reorganize project directory structure#28
refactor: Reorganize project directory structure#28ChenMiaoi wants to merge 1 commit intoopenrisc:masterfrom
Conversation
- Restructured documentation files into logical directories: * Moved tutorials and docs to pages/ with topic-based subdirectories * Consolidated platform docs under pages/platforms/ * Organized toolchain docs under pages/toolchains/ - Unified resource files under resource/ directory: * Board-specific resources moved to resource/de0_nano/ * Simulator configs moved to resource/or1ksim/ * All images centralized in resource/images/ - Updated _config.yml and index.md to reflect new structure This restructuring improves project maintainability and document discoverability by establishing a clearer and more logical file organization. Signed-off-by: chenmiao <chenmiao.ku@gmail.com>
|
I am a bit concerned about doing a refactor line this.
There are some links around the web that link to our tutorials so its not great to break it. For new pages we can suggest a new structure to follow, but older pages should try to stay where they are or we need to add permalinks. https://jekyllrb.com/docs/permalinks/ |
stffrdhrn
left a comment
stffrdhrn
left a comment
There was a problem hiding this comment.
I put a few comments, but overall I think maybe we should not do this big refactor. I tried not to change to much when updating this as there might be links to the website.
If you think its not a big deal maybe we can reconsider.
| * Run it in the reference C simulator (or1ksim) | ||
| * Run it on a simulated RTL model (Most likely extremely slow, unless using verilator) | ||
| * [Load it to RAM on an FPGA board with a debugger](Debugging.html) | ||
| * [Load it to RAM on an FPGA board with a debugger](../platforms/debugging.html) |
There was a problem hiding this comment.
For relative links would it be better to use a variable link {{ site.url }}/platforms/debugging
There was a problem hiding this comment.
Why put debugging under platform?
There was a problem hiding this comment.
For all of resources/ could we just put them together with the pages? Any reason to move to this separate directory?
There was a problem hiding this comment.
or1ksim should be under platform right?
There was a problem hiding this comment.
Should de0_nano be under resources/platform/de0_nano?
This is indeed a problem, or... perhaps we can create a new repository for the new format, then migrate the old articles to the new repository for organization, and leave the address of the new tutorial in the old tutorials? Indeed, this change is too massive, and I'm starting to doubt myself now. |
It is necessary to preserve the original repository URL, and the refactored format may also need to be revisited. |
2 participants
Regarding the packaging logic, it has not been refactored for now. I consider this to be changes rather than a refactor.
Restructured documentation files into logical directories:
Unified resource files under resource/ directory:
Updated _config.yml and index.md to reflect new structure
This restructuring improves project maintainability and document discoverability by establishing a clearer and more logical file organization.