docs: Clarify documentation gaps across the project#5701
Open
docs: Clarify documentation gaps across the project#5701
Conversation
jmuzina
commented
Nov 26, 2025
Contributor
There was a problem hiding this comment.
Pull request overview
This PR enhances project documentation by clarifying best practices, workflows, and conventions for Vanilla Framework maintainers. The documentation consolidates previously undocumented practices into accessible GitHub guides, supporting better onboarding and consistency across the team.
Key Changes
- Introduced new documentation files for language policy and CI overview
- Enhanced Percy workflow and hacking guides with additional context about examples, testing, and naming conventions
- Documented class name prefixes, patterns vs components terminology, and standalone/combined example conventions
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| guides/percy-workflow.md | Added cross-reference to hacking guide and tip about appending to combined.html files |
| guides/language.md | New file documenting en-US writing policy and mdspell usage |
| guides/hacking.md | Expanded with sections on examples relationship, combined examples, CI overview, patterns vs components, class prefixes, and language policy; fixed typo "name" → "named" |
| guides/ci.md | New comprehensive guide covering local checks, Percy, Jest, Parker, Cypress, and spelling |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Done
I'm leaving the project shortly, so I'm taking the opportunity to clarify some details and best practices that are mostly in my head or have become unspoken practice amongst Vanilla maintainers.
Check if PR is ready for release
If this PR contains Vanilla SCSS or macro code changes, it should contain the following changes to make sure it's ready for the release:
Feature 🎁,Breaking Change 💣,Bug 🐛,Documentation 📝,Maintenance 🔨.package.jsonshould be updated relative to the most recent release, following semver convention