Create docs-convention skills - #3194
Open
dessyordanova wants to merge 4 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds four GitHub “skill” definitions under .github/skills/ to enable consistent, automated Copilot-based scoring of documentation quality across core convention areas (style guide compliance, SEO, LLM/agent readability, and accessibility).
Changes:
- Introduces a style-guide scoring skill with weighted dimensions aligned to the Progress DevTools Style Guide.
- Introduces SEO and modern ranking-factor scoring (technical SEO + intent/E-E-A-T/usefulness/AI-era quality).
- Introduces LLM/agent readability scoring and accessibility (WCAG-oriented) scoring skills, each with weighted JSON outputs.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| .github/skills/style-guide-scoring/SKILL.md | Defines a weighted rubric to score a Markdown article against the Progress DevTools Style Guide and output structured JSON. |
| .github/skills/seo-doc-optimization/SKILL.md | Defines a weighted rubric for technical + modern SEO scoring of documentation with structured JSON output. |
| .github/skills/llm-doc-optimization/SKILL.md | Defines a weighted rubric to evaluate how well docs are chunked/retrieved/reasoned over by LLMs/agents with structured JSON output. |
| .github/skills/accessibility-doc-optimization/SKILL.md | Defines a weighted rubric to score documentation accessibility against WCAG-oriented practices with structured JSON output. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
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.
The purpose is to have automatic verification with each PR Copilot review for the main docs conventions