Skip to content

docs: add verified usage and development guides - #3

Merged
egorsmkv merged 1 commit into
masterfrom
docs/user-guide
Oct 8, 2026
Merged

egorsmkv merged 1 commit into
masterfrom
docs/user-guide

Conversation

@egorsmkv

@egorsmkv egorsmkv commented Oct 8, 2026

Copy link
Copy Markdown
Contributor

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:

  • cargo test --doc: default (12), std (16), entities (16), all passed, including compile-fail cases.
  • RUSTDOCFLAGS='-D warnings' cargo doc --no-deps: default and entities passed.
  • cargo fmt --check, git diff --check and repository documentation link checks passed.

The guide distinguishes current Git APIs from published 0.2.0; this PR does not bump or publish the crate version.

@egorsmkv
egorsmkv merged commit ae3fe9c into master Oct 8, 2026
4 checks passed
@egorsmkv
egorsmkv deleted the docs/user-guide branch October 8, 2026 15:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant