Display code next to spec
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 2.6k
- Forks
- 288
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 8
Description
Many parts of the parser code closely match sections of the HTML5 syntax spec. We should include machine-readable comments describing this correspondence, and then generate a HTML document with syntax-highlighted Rust code next to spec excerpts.
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 by locating parser code that corresponds to the HTML5 syntax specification and determine how those correspondences should be represented as machine-readable comments. Then identify the process for generating an HTML document with syntax-highlighted Rust beside the relevant spec excerpts. Done means the correspondence is recorded and the generated document presents both sides together.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html, rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100