Meridian

Documentation intelligence for developers - wwwwwwww

Meridian reviews READMEs and markdown for structure, readability, link quality, inclusive language, and code examples. Paste your docs or point at a GitHub repo and get a score, grade, and actionable feedback.

Same tier as a strong hackathon / portfolio project: full-stack, useful domain, demo-able in 30 seconds.

The problem

Bad READMEs kill open-source projects. New contributors bounce when docs are unclear, exclusive, or missing install steps. Meridian automates the first pass of doc review so you catch issues before publishing.

Features

• Markdown review — paste any README or doc
• GitHub integration — fetch and analyze a repo's README.md
• Structure linting — heading hierarchy, required sections
• Readability scoring — Flesch reading ease + grade level
• Link quality — empty/vague link text detection
• Inclusive language — flags terms like blacklist/whitelist with suggestions
• Code block checks — language tags, missing examples
• Review history — saved in MongoDB

Stack

Layer	Tech
Frontend	React, TypeScript, Tailwind CSS, Vite
Backend	Express, TypeScript
Database	MongoDB

Run locally

npm install
npm install --prefix server
npm install --prefix client

cp server/.env.example server/.env

npm run dev

Open http://localhost:5173

Try the built-in sample README (intentionally bad) or paste a GitHub URL.

API

Method	Endpoint	Body
POST	/api/reviews/markdown	{ "markdown": "..." }
POST	/api/reviews/github	{ "url": "https://github.com/owner/repo" }
GET	/api/reviews	List recent reviews
GET	/api/reviews/:id	Full review

License

MIT