Skip to content

Create docs/ Folder Structure #11

@4eckd

Description

@4eckd

Documentation System Architecture

Create docs/ Folder Structure

docs/
├── README.md                    # Index of all documentation
├── catalog.yml                  # Machine-readable catalog
├── processes/                   # Process checklists
│   ├── README.md
│   ├── COMMIT_CHECKLIST.md
│   ├── PULL_REQUEST_CHECKLIST.md
│   ├── MERGE_CHECKLIST.md
│   ├── ISSUE_CHECKLIST.md
│   ├── DISCUSSION_CHECKLIST.md
│   ├── COMMENT_CHECKLIST.md
│   └── RELEASE_CHECKLIST.md
├── guides/                      # User guides (symlinks or references)
│   ├── workspace-setup.md       # Link to WORKSPACE_GUIDE.md
│   ├── label-management.md      # Link to .github/LABELS_README.md
│   └── project-boards.md        # Link to .github/PROJECT_BOARD_GUIDE.md
├── governance/                  # Governance docs (symlinks or references)
│   ├── governance.md            # Link to .github/GOVERNANCE.md
│   ├── contributing.md          # Link to .github/CONTRIBUTING.md
│   ├── goals.md                 # Link to .github/GOALS.md
│   └── security.md              # Link to .github/SECURITY.md
├── technical/                   # Technical documentation
│   ├── workflows.md             # Link to .github/workflows/README.md
│   ├── label-sync.md            # Link to .github/workflows/SYNC_LABELS_SETUP.md
│   └── automation.md            # New: comprehensive automation guide
└── setup/                       # Setup guides
    ├── quick-start.md           # Link to .github/QUICK_START.md
    ├── checklist.md             # Link to .github/SETUP_CHECKLIST.md
    └── label-sync-fix.md        # Link to .github/LABEL_SYNC_FIX.md

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions