`RcDom` issues in `html2html` example
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 2.6k
- Forks
- 288
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 8
Description
I am trying to figure out how to use this parser, and as far as I can tell, the only "getting started" documentation you provide is the html2html example.
html2html uses the markup5ever_rcdom package, which you have decided to make "unofficial" because it is unsafe and incorrect. This means two things:
-
The
html2htmlexample doesn't build by default and provides the message "the traitTreeSinkis not implemented forRcDom". It took me quite a lot of hair pulling to figure out that you must pin themarkup5ever_rcdomto version0.5.0-unofficialto fix that problem. -
If the only documentation you have for using this crate is a bad implementation, how am I supposed to use it? If you had some documentation on how I could write my own
RcDomthat would go a long way, but I don't see any.
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 with the html2html example and reproduce its default build failure, then inspect how it depends on markup5ever_rcdom. Review the linked discussion about RcDom's unofficial status and determine what documentation is needed for writing a custom RcDom. Done means the example's dependency guidance is correct and users have usable documentation for parser integration.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100