Skip to content

feat(docs): update documentation skills with new required sections#465

Open
Hristo313 wants to merge 4 commits into
vnextfrom
hhristov/update-doc-skills
Open

feat(docs): update documentation skills with new required sections#465
Hristo313 wants to merge 4 commits into
vnextfrom
hhristov/update-doc-skills

Conversation

@Hristo313

Copy link
Copy Markdown
Contributor

Closes #

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)

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the Ignite UI documentation authoring/auditing “skills” to add new required topic sections/subsections and refine xplat frontmatter/title guidance, so generated and audited docs follow a consistent canonical structure.

Changes:

  • Adds guidance for xplat component frontmatter to avoid repeating product names in title.
  • Updates topic structure guidance to require ### Prerequisites and Version Compatibility under Getting Started and adds new required end-of-topic sections (Known Limitations, Related Components, FAQ).
  • Updates the audit rubric to reflect the expanded required section set.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.

File Description
.ai/skills/igniteui-topic-frontmatter/SKILL.md Adds xplat frontmatter/title guidance intended to reduce duplicated product naming.
.ai/skills/igniteui-doc-topics/SKILL.md Updates required section/subsection checklist and Diátaxis section→mode mapping.
.ai/skills/igniteui-doc-topics/references/house-style.md Updates the canonical H2 order to include new required sections and the new Getting Started subsection requirement.
.ai/skills/igniteui-doc-topics/references/audit-rubric.md Updates audit “Structure & order” checks to include the new required sections/subsections.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread .ai/skills/igniteui-topic-frontmatter/SKILL.md
Comment thread .ai/skills/igniteui-doc-topics/SKILL.md Outdated
Comment thread .ai/skills/igniteui-doc-topics/references/audit-rubric.md Outdated
@Hristo313 Hristo313 added ❌ status: awaiting-test PRs awaiting manual verification doc-redesign labels Jul 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc-redesign ❌ status: awaiting-test PRs awaiting manual verification

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants