feat(docs): update documentation skills with new required sections#465
Open
Hristo313 wants to merge 3 commits into
Open
feat(docs): update documentation skills with new required sections#465Hristo313 wants to merge 3 commits into
Hristo313 wants to merge 3 commits into
Conversation
Contributor
There was a problem hiding this comment.
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 Compatibilityunder 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.
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.
Closes #
Checklist:
preview/beta./page.mdxor../relative/path.mdx(.mdxextension required)IgxSelectComponent,<igx-combo>code blocksfor the names of classes / tags / propertiescode blockscheck-api/mdxnpm commandsllms.descriptionmetadata and runnpm run check:llms-metadata