Skip to content

Restructure documentation with Diátaxis framework (issue #40)#41

Merged
virtualian merged 1 commit into
mainfrom
40-formal-documentation
Dec 8, 2025
Merged

Restructure documentation with Diátaxis framework (issue #40)#41
virtualian merged 1 commit into
mainfrom
40-formal-documentation

Conversation

@virtualian

Copy link
Copy Markdown
Owner

Summary

  • Reorganize docs by user role (users/, contributors/) then content type (how-to/, reference/, explanation/) following Diátaxis principles
  • Old docs preserved in deprecated/docs-v1/ for reference
  • Update MARR standards to require Diátaxis content types and explicit "no changes on main" rule

New Structure

docs/
├── README.md
├── users/
│   ├── how-to/
│   │   ├── getting-started.md
│   │   ├── scan-projects.md
│   │   ├── validate-packages.md
│   │   └── integrate-with-ci.md
│   ├── reference/
│   │   └── command-reference.md
│   └── explanation/
│       └── threat-model.md
└── contributors/
    ├── how-to/
    │   └── contributing.md
    ├── reference/
    │   └── architecture.md
    └── explanation/
        └── design-decisions.md

Closes #40

Reorganize docs by user role (users/, contributors/) then content type
(how-to/, reference/, explanation/) following Diátaxis principles.

New structure:
- docs/users/how-to/ - Setup, scanning, validation, CI integration
- docs/users/reference/ - Command reference
- docs/users/explanation/ - Threat model
- docs/contributors/how-to/ - Contributing guide
- docs/contributors/reference/ - Architecture
- docs/contributors/explanation/ - Design decisions

Old docs preserved in deprecated/docs-v1/ for reference.

Also updates MARR standards:
- Documentation standard now requires Diátaxis content types
- Workflow standard adds explicit "no changes on main" rule
@virtualian virtualian merged commit 4df87d9 into main Dec 8, 2025
4 checks passed
@virtualian virtualian deleted the 40-formal-documentation branch December 8, 2025 22:15
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.

Create formal project documentation

1 participant