Improve audit docs prompt to include Diátaxis framework #568
Conversation
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
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR enhances the documentation audit prompt system by incorporating the Diátaxis framework for documentation organization and strengthening enforcement of objectivity and accuracy standards.
Key Changes:
- Added Diátaxis framework integration for new documentation structures (tutorials, how-to guides, reference, explanation)
- Strengthened rules around factual accuracy and objective technical writing
- Enhanced Mermaid diagram guidelines with specific complexity thresholds
Reviewed changes
Copilot reviewed 9 out of 11 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| package.json | Minor version bumps for MUI, Cypress, and related dev dependencies |
| docs/usage/testing.md | Added implementation citations and Related Documentation section |
| docs/architecture/service-worker.md | Expanded service worker registration documentation with implementation links |
| docs/architecture/pwa.md | Added implementation citation and standardized Related Documentation section |
| docs/architecture/layouts.md | Added implementation citation and renamed section to Related Documentation |
| docs/architecture/images.md | Updated project name reference, added implementation citation, removed emoji headings and tip section |
| docs/architecture/configs.md | Added implementation citation, removed emoji headings and redundant sections |
| docs/architecture/components/avatar.md | Updated accessibility documentation with accurate component attributes and fixed Related Documentation links |
| .github/prompts/audit-docs.prompt.md | Major expansion of documentation audit guidelines incorporating Diátaxis framework, objectivity rules, and citation requirements |
Comments suppressed due to low confidence (1)
docs/architecture/images.md:3
- Inconsistent project naming. Line 3 uses 'Alexander Sullivan's Portfolio' while the configs.md file (line 3) uses 'AlexJSully's Portfolio'. The project name should be consistent across all documentation files.
This document explains how images and icons are used, organized, and named in Alexander Sullivan's Portfolio project, and how contributors can add their own.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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.
No description provided.