[FIRRTL] FIRRTLAnnotations.md images not rendering on website
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 2.2k
- Forks
- 524
- Avg merge
- 3d 2h
- Merged PRs (30d)
- 46
Description
From: https://github.com/llvm/circt/pull/3351#issue-1271452116
In addition to these changes, I noticed that the two pictures in the folded-vs-unfolded-modules table (at the bottom of [this section](https://circt.llvm.org/docs/FIRRTLAnnotations/#targets)) aren't displaying on the website. I'm not completely sure what the right fix is for that. The diagrams can be found here:
https://circt.llvm.org/includes/img/firrtl-folded-module.png
https://circt.llvm.org/includes/img/firrtl-unfolded-module.png
However, the page is trying to find them at these URLs:
https://circt.llvm.org/docs/FIRRTLAnnotations/includes/img/firrtl-folded-module.png
https://circt.llvm.org/docs/FIRRTLAnnotations/includes/img/firrtl-unfolded-module.png
The images are rendered properly when opening the markdown document in GitHub. I'm not totally sure how the website is set up, but if you have a recommendation for the right fix, I'm happy to include it in this PR.
-Tynan
Contributor guide
No contributing guide indexed for this repository
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 at the folded-vs-unfolded-modules table in FIRRTLAnnotations.md and compare its image references with the working files under /includes/img. Check the documentation site's path handling, then verify that both diagrams render at the intended website URLs.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100