Skip to content

iamharkirat/docs_analysis_tool

Repository files navigation

Docs Analysis Tool

A Next.js app that crawls a prospect's documentation site and generates a gap analysis report — showing which Mintlify features they're missing and how strong the sales opportunity is.

How it works

  1. Enter a company name and their docs URL
  2. The app crawls up to 50 pages using Playwright (headless Chromium)
  3. A detection engine scans the HTML, scripts, and metadata to check for 14 Mintlify features
  4. Results are scored and surfaced in a report with per-feature talking points

Features checked

Group Features
AI Ready LLM Optimizations, MCP Server, AI Assistant, AI Translations, User Feedback
API Docs API Playground, Websockets/Real-time, Built-in Components, Custom CSS & JS, White Labeling
Search & Access Search, Custom Domain, Authentication, PDF Export

Each feature is flagged as present, absent, or uncertain, and tagged with the Mintlify plan required (Hobby / Pro / Enterprise).

Getting started

npm install
npx playwright install chromium
npm run dev

Open http://localhost:3000.

Tech stack

  • Next.js 14 (App Router)
  • Playwright — headless crawling
  • Tailwind CSS — styling
  • TypeScript

Scripts

Command Description
npm run dev Start dev server
npm run build Production build
npm run analyse Run the standalone CLI analyser (analyse.mjs)

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors