Skip to content

feat(docs): update category overview topic skill rules - #489

Open
Hristo313 wants to merge 1 commit into
vnextfrom
hhristov/update-topics-skill
Open

feat(docs): update category overview topic skill rules#489
Hristo313 wants to merge 1 commit into
vnextfrom
hhristov/update-topics-skill

Conversation

@Hristo313

@Hristo313 Hristo313 commented Aug 10, 2026

Copy link
Copy Markdown
Contributor

Update the skill rules for category overview topics structure

Checklist:

  • check topic's TOC/menu and paragraph headings
  • Include TOC topic labels in the topic content when it has a valuable update, is new, or is considered preview / beta
  • link to other topics using ./page.mdx or ../relative/path.mdx (.mdx extension required)
  • at the References section at the end of the topic add links to topics, samples, etc
  • reference API documentation instead of adding a section with API

  • use valid component names - [Data] Grid, IgxSelectComponent, <igx-combo>
  • use spell checker tool (VS Code, Grammarly, Microsoft Editor)
  • add inline code blocks for the names of classes / tags / properties
  • add language descriptor for the code blocks
  • check if links function by running the check-api/mdx npm commands
  • check if sample is working and fully visible in the topic
  • check if sample is working and fully visible in the StackBlitz
  • check if code blocks match the code in StackBlitz demo
  • add or update meaningful llms.description metadata and run npm run check:llms-metadata


  • do not resolve requested changes (leave that to the reviewer)

@Hristo313 Hristo313 added the ❌ status: awaiting-test PRs awaiting manual verification label Aug 10, 2026
@IMinchev64 IMinchev64 added ✅ status: verified Applies to PRs that have passed manual verification and removed ❌ status: awaiting-test PRs awaiting manual verification labels Aug 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

✅ status: verified Applies to PRs that have passed manual verification

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants