Skip to content

Comments

Create comprehensive MARR documentation (#29)#66

Merged
virtualian merged 1 commit intomainfrom
29-create-documentation
Dec 8, 2025
Merged

Create comprehensive MARR documentation (#29)#66
virtualian merged 1 commit intomainfrom
29-create-documentation

Conversation

@virtualian
Copy link
Owner

Summary

  • Add user documentation: getting-started, configuration, customization, standards-reference
  • Add developer documentation: contributing, testing, publishing, specification, architecture
  • Restructure docs with role-first + Diátaxis organization (user/devhow-to/reference/explanation)
  • Set up Docsify for GitHub Pages publishing
  • Consolidate and delete outdated dev docs
  • Update README with documentation links

Documentation Structure

docs/
├── user/
│   ├── how-to/
│   │   ├── getting-started.md
│   │   └── customization.md
│   ├── reference/
│   │   └── standards-reference.md
│   └── explanation/
│       └── configuration.md
└── dev/
    ├── how-to/
    │   ├── contributing.md
    │   ├── testing.md
    │   └── publishing.md
    └── explanation/
        ├── specification.md
        └── architecture.md

Test plan

  • Run docsify serve docs locally and verify navigation works
  • Verify all internal links resolve correctly
  • After merge, enable GitHub Pages from /docs folder

Closes #29

- Add user docs: getting-started, configuration, customization, standards-reference
- Add dev docs: contributing, testing, publishing, specification, architecture
- Restructure docs with role-first + Diátaxis organization (user/dev → how-to/reference/explanation)
- Set up Docsify for GitHub Pages publishing
- Consolidate and delete outdated dev docs (TESTING.md, NPM_PUBLISH_CHECKLIST.md, etc.)
- Update README with documentation links
@virtualian virtualian merged commit 1d0bf54 into main Dec 8, 2025
3 checks passed
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 proper documentation for MARR

1 participant