Create a "Get started" page#1594
Merged
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1594 +/- ##
=========================================
Coverage 97.44% 97.44%
Complexity 988 988
=========================================
Files 213 213
Lines 2273 2273
=========================================
Hits 2215 2215
Misses 58 58 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull request overview
This pull request creates a new "Get started" page to help users quickly begin using Respect\Validation. The PR also reorganizes the documentation structure by removing numbered prefixes from filenames and implements a navigation weight system using the mkdocs-nav-weight plugin to control page ordering.
Key changes:
- Introduces a new "Get started" page with basic installation and usage examples
- Migrates existing documentation content into new files with cleaner naming (removing numeric prefixes)
- Adds mkdocs-nav-weight plugin for better documentation navigation control
Reviewed changes
Copilot reviewed 15 out of 22 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/get-started.md | New introductory guide with installation instructions and basic usage examples |
| docs/feature-guide.md | Reorganized feature guide with navigation weight metadata |
| docs/handling-exceptions.md | New comprehensive guide for exception handling in validation |
| docs/message-translation.md | New guide for translating validation messages |
| docs/message-placeholder-conversion.md | New guide for customizing parameter stringification |
| docs/custom-validators.md | New guide for creating custom validators |
| docs/concrete-api.md | New guide explaining the non-fluent API usage |
| docs/comparable-values.md | New guide explaining supported comparable value types |
| docs/list-of-validators-by-category.md | Generated file with all validators organized by category |
| docs/license.md | Added navigation weight metadata |
| docs/index.md | Updated links to remove numeric prefixes |
| README.md | Updated documentation links to remove numeric prefixes |
| docs/validators/*.md | Updated cross-references to remove numeric prefixes |
| src-dev/Commands/UpdateDocLinksCommand.php | Updated output path for validator list file |
| mkdocs.yml | Added mkdocs-nav-weight plugin configuration |
| docs/requirements.txt | Added mkdocs-nav-weight dependency |
| docs/01-installation.md | Removed (content migrated to get-started.md) |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
henriquemoody
force-pushed
the
docs/get-started
branch
from
9f94f50 to
7765f3f
Compare
Member
|
I think "Getting Started" is more appropriate for documentation. "Get Started" is what I would use in a call-to-action button. |
alganet
reviewed
Jan 9, 2026
henriquemoody
force-pushed
the
docs/get-started
branch
from
7765f3f to
213b418
Compare
henriquemoody
force-pushed
the
docs/get-started
branch
from
213b418 to
a64edfc
Compare
That allows users to quickly start playing with Validation.
henriquemoody
force-pushed
the
docs/get-started
branch
from
a64edfc to
4cc45b5
Compare
alganet
approved these changes
Jan 10, 2026
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.
That allows users to quickly start playing with Validation.
This page should contain only the very basic information for users to get started with Validation, the "Feature Guide" page should be the one that has more details.