Skip to content

docs: explain why MDU, compare it with other tools, and add a contributing guide - #230

Merged
capjan merged 6 commits into
mainfrom
docs/repo-presentation
Nov 10, 2026
Merged

capjan merged 6 commits into
mainfrom
docs/repo-presentation

Conversation

@capjan

@capjan capjan commented Nov 9, 2026

Copy link
Copy Markdown
Owner

What changed

  • README: new "Why MDU" section with six key points (one tool to set up, plain Markdown, linting in CI, static SVG diagrams, PDF export, migration from Material for MkDocs) and a link to the comparison.
  • Docs/OtherTools.md: new "How MDU compares" table covering MDU, Material for MkDocs, Docusaurus, Starlight, and DocFX (build runtime, linter, diagrams, PDF export, source format).
  • CONTRIBUTING.md: how to report issues, development setup with the .NET SDK, Conventional Commits, and pull request guidelines.

Why

First step of making MDU easier to discover: visitors should quickly see what MDU offers and how to contribute. The wording describes what MDU includes instead of setting it against other platforms. The repository description and topics on GitHub were updated separately.

For reviewers

  • The MDU column was checked against the docs. The other columns are from general knowledge; please double-check the "Plugins" cells and Starlight's Mermaid support.
  • mdu render Docs and mdu lint Docs pass; the #how-mdu-compares anchor used by the README link exists.

@capjan
capjan merged commit dc9444e into main Nov 10, 2026
7 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.

1 participant