Repository navigation
docs: add verified usage and development guides - #3
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The README lacked a complete extraction example and the parse rustdoc still recommended the legacy unsafe owned constructor. Add a current-source quickstart, feature table, usage guide and development guide covering ownership, attributes, selector rejection, decoded text, bounded capacities, migration and HTML5 limitations.
Include the usage guide in crate rustdoc so its Rust examples run as doctests. Update the owned-input recommendation to VDomGuard::parse. Extend CI path filters to docs/** and add strict default/entities rustdoc builds. Parser behavior and dependencies are unchanged.
Validation on Rust 1.99.0:
The guide distinguishes current Git APIs from published 0.2.0; this PR does not bump or publish the crate version.