odb: add LEF/DEF grammar railroad diagram docs#9509
Open
Bbn08 wants to merge 2 commits intoThe-OpenROAD-Project:masterfrom
Open
odb: add LEF/DEF grammar railroad diagram docs#9509Bbn08 wants to merge 2 commits intoThe-OpenROAD-Project:masterfrom
Bbn08 wants to merge 2 commits intoThe-OpenROAD-Project:masterfrom
Conversation
Add documentation pages for the LEF and DEF grammars with EBNF summaries and links to the interactive railroad diagram generator. Resolves The-OpenROAD-Project#2488 Signed-off-by: Bbn08 <atrancendentbeing@gmail.com>
Contributor
There was a problem hiding this comment.
Code Review
This pull request is a valuable addition, providing clear documentation for the LEF and DEF grammars. Using an external tool for interactive railroad diagrams is a smart approach to keep the documentation concise and user-friendly. The new markdown files are well-written and the changes to toc.yml are correct. I have one minor suggestion regarding a typo in DEF_Grammar.md that originates from the source code.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Signed-off-by: Bbn08 <atrancendentbeing@gmail.com>
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.
Add documentation pages for the LEF and DEF grammars with EBNF summaries and links to the interactive railroad diagram generator.
Resolves #2488
Description
Add documentation pages for the LEF and DEF grammar files with EBNF summaries
and instructions for viewing interactive railroad diagrams.
Each page includes:
for interactive viewing
Files Changed
Design Note
Note
Rather than embedding the full EBNF grammars directly into the documentation pages (which would be very large), I opted for a lighter approach:
If you'd prefer the full EBNF grammars included directly in the Markdown files (or as separate
.ebnffiles committed to the repo), I'm happy to update the approach.