Feat: docs, code frm percy

packages/html-validation/src/lib.rs

@@ -0,0 +1,42 @@
+//! The html-validation crate provides method that can be used when validating html elements
+//! and attributes.
+//!
+//! The original goal of this crate was to be used as a dependency in procedural macros that
+//! validate html at compile time, but it is general purpose and can be used in other problem
+//! spaces.
+//!
+//! ## Potential Strategy - Pessimistic Validation
+//!
+//! We might make the html-validation crate is pessimistic by nature.
+//!
+//! This means that as we develop the create we'll blacklist more and more things - but in general
+//! we default to not saying that something is invalid until we've specifically encoded that it is
+//! not allowed.
+//!
+//! This means that you'll see methods with names like `is_definitely_invalid_child` - hinting
+//! that we're telling you that we're certain that the relationship is not allowed.
+//!
+//! Over time we'll cover more and more cases and this should become a non issue, but at the
+//! beginning it will mean that our validation is less strict than it should really be.
+//!
+//! The reason behind this strategy is that it lets people get up and running from day one without
+//! needing to wait until our validation is perfect.
+//! A downside is that as we become more and more strict there might be situations where you have
+//! to go back and tweak your html if you had something that we are now calling invalid.
+//!
+//! ## Potential Strategy - Optimistic Validation
+//!
+//! In this case we'd make html! generate a compile time error for anything that isn't certainly valid.
+//! Then there would be a second macro such as html_unstrict! that would be a bit more permissive.
+//!
+//! Over time as our validation permitted more cases people could use html! more and more instead of html_loose!
+
+#![deny(missing_docs)]
+
+pub use self_closing::is_self_closing;
+pub use svg_namespace::is_svg_namespace;
+pub use valid_tags::is_valid_tag;
+
+mod self_closing;
+mod svg_namespace;
+mod valid_tags;