Refine adapters, examples, and migration guidance #15
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Pull request overview
This PR refines documentation across adapters, examples, and migration guidance to improve clarity, consistency, and usability. The changes primarily focus on standardizing terminology, improving formatting, and adding helpful reference sections.
Changes:
- Standardized terminology from "transformation" to "conversion" across adapter and example documentation
- Improved list formatting by using colons to separate items from descriptions
- Added new sections for workflow guidance, requirements, validation checklists, and reference links
- Minor wording improvements for clarity
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/governance/troubleshooting.md | Added Workflow and Review checklist sections, improved terminology, added Links section |
| docs/examples/figma-export.md | Updated terminology and punctuation for consistency |
| docs/examples/adapter-pipeline.md | Added Requirements and Out of scope sections, renamed "Validation points" to "Validation checklist" |
| docs/adoption/migration-strategy.md | Added scope and failure descriptions, improved wording |
| docs/adapters/tokens-studio.md | Updated terminology from "transformation" to "conversion" |
| docs/adapters/style-dictionary.md | Improved list formatting with colons |
| docs/adapters/index.md | Improved list formatting with colons |
| docs/adapters/figma.md | Updated terminology and wording for consistency |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -1,11 +1,18 @@ | |||
| --- | |||
| title: Governance - Troubleshooting | |||
| title: Governance: Troubleshooting | |||
There was a problem hiding this comment.
The title format uses a colon (":") but should use a dash ("-") to be consistent with other governance documents. All other files in docs/governance/ use the format "Governance - SectionName" (e.g., "Governance - Validation", "Governance - Change Control", "Governance - Migration"). This inconsistency could cause issues with documentation navigation or indexing systems.
| @@ -1,10 +1,12 @@ | |||
| --- | |||
| title: Adoption - Migration Strategy | |||
| title: Adoption: Migration Strategy | |||
There was a problem hiding this comment.
The title format uses a colon (":") but should use a dash ("-") to be consistent with other adoption documents. All other files in docs/adoption/ use the format "Adoption - SectionName" (e.g., "Adoption - Getting Started", "Adoption - Implementation Checklist"). This inconsistency could cause issues with documentation navigation or indexing systems.
No description provided.