Skip to content

docs(skills): add canonical Diataxis folder paths to all writer skills#121

Merged
gtauzin merged 2 commits into
mainfrom
feat/diataxis-skills-sync
Mar 28, 2026
Merged

docs(skills): add canonical Diataxis folder paths to all writer skills#121
gtauzin merged 2 commits into
mainfrom
feat/diataxis-skills-sync

Conversation

@gtauzin

@gtauzin gtauzin commented Mar 28, 2026

Copy link
Copy Markdown
Member

Description

Add canonical folder path recommendations to all 5 Diataxis writer skills and sync them across template/.github/skills/ and .github/skills/.

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Refactoring (no functional changes)
  • Other (please describe):

Motivation and Context

The Diataxis writer skills lacked guidance on where to place generated files. This adds a File Placement section to each writer skill prescribing the canonical pages/tutorials/, pages/how-to/, pages/reference/, pages/explanation/ folder paths. Also updates the docs-planner nav patterns to match.

How Has This Been Tested?

  • Tested locally with uv run pytest
  • All tests pass

Checklist

  • My code follows the code style of this project
  • I have updated the documentation accordingly
  • All new and existing tests passed
  • My changes generate no new warnings

gtauzin added 2 commits March 28, 2026 17:51
- Add File Placement section to tutorial, howto, reference, and explanation writers
- Update docs-planner MkDocs Nav Patterns with pages/ folder-per-quadrant structure
- Fix stale getting-started.md link in howto-writer template
- Sync all skills across template/.github/skills and .github/skills
The root and generated project rumdl versions disagree on nested list
indent width for MD007. Add per-file-ignores for .github/skills/** to
prevent false positives in both the root and generated projects.
@gtauzin gtauzin merged commit 4adfa1b into main Mar 28, 2026
13 checks passed
@gtauzin gtauzin deleted the feat/diataxis-skills-sync branch March 28, 2026 17:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant