Update `xml5ever/README.md` to reflect current API documentation
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 2.6k
- Forks
- 288
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 8
Description
Currently xml5ever/README.md refers in
If you need docs checkout either API docs or run cargo docs to generate documentation.
to https://ygg01.github.io/docs/xml5ever/xml5ever/index.html, which hosts a very outdated API documentation
also, it seems the README is generally outdated (like using function parse that i cant find anywhere, maybe needs to be updated to parse_document?)
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 xml5ever/README.md and compare its API links and examples with the current xml5ever API documentation. Check whether parse has been replaced by parse_document, update outdated references and the documentation link, and confirm that the README matches the current API.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100