[doc] Update directory structure overview
Nobody has claimed this yet.
- Dominant language
- SystemVerilog
- Stars
- 3.6k
- Forks
- 1.1k
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 141
Description
As I was going through the documentation while onboarding, I've found that the directory structure described under `doc/ug/directory_structure.md` is a bit outdated and doesn't match the current codebase. In particular:
- Directories `top_englishbreakfast`, `syn`, `data`, and `ip_templates` are missing from "Directory structure under `hw`"
- Directories `silicon_creator`, `otp_img`, `riscv_compliance_support`, and `sca` are missing from "Directory structure under `sw`"
- Directory `sw/device/doc` is listed but does not exist (is this now the top-level `doc`?)
- `sw/silicon_creator/boot_rom` is described as "Sources for generating the primary boot image loaded into ROM", which if I understand correctly is no longer the case
I'm happy to update these according to my understanding, but I'd appreciate getting help/feedback from someone who knows the codebase better!
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with doc/ug/directory_structure.md and compare its hw and sw listings with the current repository directories. Check whether sw/device/doc still exists and verify the description of sw/silicon_creator/boot_rom against the current codebase. Done means the overview lists current directories and accurately describes boot_rom.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100