Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FIRRTL Rationale #85

Open
dtzSiFive opened this issue Mar 7, 2023 · 2 comments
Open

FIRRTL Rationale #85

dtzSiFive opened this issue Mar 7, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@dtzSiFive
Copy link
Member

We should add a place to document the "Rationale" for FIRRTL's design, perhaps in the spirit of MLIR's rationales: https://mlir.llvm.org/docs/Rationale/ .

This has been proposed and requested by a number of folks actively contributing to the specification, and let's start sorting out what this might look like and where.

@dtzSiFive dtzSiFive added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 7, 2023
@dtzSiFive
Copy link
Member Author

One candidate detail to include in such a rationale would be the motivation around some of the reference type design (under assumption it's merged of course), probably in general but specifically regarding input probe types. Request: #75 (comment)

@seldridge
Copy link
Member

#147 improves how block quotations are rendered to make them look like RISC-V Specification commentary blocks (an italicized region with increased left and right indentation and a rule at the top). This may help fill the gap for things which are explanatory, but outside the realm of what should be discussed in the spec.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants