Repository navigation
Conversation
The tutorial links the ibex design details to flow/designs/src/ibex/README.md, which does not exist and returns 404. The sky130hd/ibex design builds from flow/designs/src/ibex_sv, whose README describes the core, so point the link there. Signed-off-by: mmporong <mmporong@gmail.com>
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request updates a documentation link in docs/tutorials/FlowTutorial.md to point to the ibex_sv README instead of the ibex README. The review feedback suggests using a relative link instead of an absolute GitHub URL to ensure the link works correctly across different branches, forks, and offline environments.
| Run the `ibex` design in OpenROAD-flow-scripts automated flow from | ||
| RTL-to-GDS using `sky130hd`. Find `ibex` design details | ||
| [here](https://github.com/The-OpenROAD-Project/OpenROAD-flow-scripts/blob/master/flow/designs/src/ibex/README.md) | ||
| [here](https://github.com/The-OpenROAD-Project/OpenROAD-flow-scripts/blob/master/flow/designs/src/ibex_sv/README.md) |
Contributor
There was a problem hiding this comment.
Using relative links instead of absolute GitHub URLs is preferred for internal repository links. This ensures that the links work correctly across different branches, forks, and offline environments.
Suggested change
| [here](https://github.com/The-OpenROAD-Project/OpenROAD-flow-scripts/blob/master/flow/designs/src/ibex_sv/README.md) | |
| [here](../../flow/designs/src/ibex_sv/README.md) |
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
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.
The flow tutorial's "Find
ibexdesign details here" link points toflow/designs/src/ibex/README.md, which does not exist (GitHub returns 404). Thesky130hd/ibexdesign that the tutorial runs takes its sources fromflow/designs/src/ibex_sv(see itsconfig.mk), andflow/designs/src/ibex_sv/README.mdis the README that describes the core, so the link now points there.There are no other links to
designs/src/ibex/underdocs/. Checked withcurl: the old URL returns 404 and the new one 200.