Skip to content

docs: restructure documentation following Diataxis framework#119

Merged
gtauzin merged 2 commits into
mainfrom
docs/diataxis-restructure
Mar 28, 2026
Merged

docs: restructure documentation following Diataxis framework#119
gtauzin merged 2 commits into
mainfrom
docs/diataxis-restructure

Conversation

@gtauzin

@gtauzin gtauzin commented Mar 26, 2026

Copy link
Copy Markdown
Member

Reorganize documentation into the four Diataxis quadrants:

  • Tutorials: quickstart (existing, updated cross-links)
  • How-to Guides: setup CI/CD, customize template, update template, add dependencies, contribute
  • Reference: template variables, project structure, GitHub workflows, commands, configuration
  • Explanation: architecture, release process

Also adds Diataxis skills for consistent doc generation and expands the template's contributing guide.

gtauzin added 2 commits March 26, 2026 10:58
Reorganize docs into four quadrants: tutorials, how-to guides,
reference, and explanation pages. Add new pages for architecture,
release process, template variables, project structure, CI/CD setup,
and more. Update nav structure, cross-links, and contributing guides.
- Auto-fix MD007 (indent depth) and MD040 (missing code language)
- Use 4-backtick fences for nested code blocks (MD070/MD057)
- Remove dead example link in reference-writer template
@gtauzin gtauzin merged commit 8ae16ff into main Mar 28, 2026
13 checks passed
@gtauzin gtauzin deleted the docs/diataxis-restructure branch March 28, 2026 15:41
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