Update and improve the documentation of MLIR dialects
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 1.1k
- Forks
- 456
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 165
Description
We publish some documentation about the MLIR dialects that is used by nvq++ compiler, but these are very bare bones so far. For example, documentation about the types and operators is missing. Some documentation is generated by cudaq-doc build target, but not all of the generated documentation is included in the published docs. Even though the dialects are under heavy development and are not stable at this point, it would be nice to make more (generated) documentation available in some form.
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
Review the existing published MLIR dialect documentation and the cudaq-doc build target first. Identify the missing type and operator coverage and which generated material is omitted; done means the published documentation exposes the agreed additional dialect information despite ongoing development.
Written by the indexing model from the issue text.
Assessment
- Domain
- compilers, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100