Skip to content

docs(validation): add draft of feature page #3606

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Feb 18, 2025
Merged

Conversation

dreamorosi
Copy link
Contributor

@dreamorosi dreamorosi commented Feb 15, 2025

Summary

Changes

Please provide a summary of what's being changed

This PR adds a first draft of the documentation page for the upcoming Validation utility.

This page, while published, is not referenced anywhere nor linked in the actual documentation and can be accessed only by knowing the URL. Even if stumbled upon, it contains a disclaimer stating it's an unreleased feature.

The idea of having this page is that it will help contributors understand the implementation and serve as reference.

Note

We will do a full review and team editing before actually publishing and after the implementation is complete.

Please add the issue number below, if no issue is present the PR might get blocked and not be reviewed

Issue number: #3605


By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

@dreamorosi dreamorosi self-assigned this Feb 15, 2025
@dreamorosi dreamorosi requested a review from a team February 15, 2025 18:10
@dreamorosi dreamorosi requested a review from a team as a code owner February 15, 2025 18:10
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Feb 15, 2025
@pull-request-size pull-request-size bot added the size/XL PRs between 500-999 LOC, often PRs that grown with feedback label Feb 15, 2025
@dreamorosi dreamorosi linked an issue Feb 17, 2025 that may be closed by this pull request
1 task
Copy link
Contributor

@am29d am29d left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great doc, thanks for the work! Just few comments

@dreamorosi dreamorosi requested a review from am29d February 17, 2025 14:52
@am29d am29d merged commit e03ffc0 into main Feb 18, 2025
41 checks passed
@am29d am29d deleted the docs/validation_draft branch February 18, 2025 08:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation size/XL PRs between 500-999 LOC, often PRs that grown with feedback
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: add draft for Validation utility docs
2 participants