fix(monodog): merge pull request #23 from mindfiredigital/development

Release Development

Author: anandmindfire

documentation/README.md

@@ -2,7 +2,7 @@
 
 Complete documentation for the Monodog monorepo analytics and health dashboard API.
 
-## 📚 Overview
+## Overview
 
 This documentation covers everything you need to know to install and use Monodog in your monorepo:
 
@@ -11,9 +11,8 @@ This documentation covers everything you need to know to install and use Monodog
 - **Usage Guide**: How to use the dashboard and API
 - **Features**: Detailed feature documentation
 - **API Reference**: Complete REST API documentation
-- **Troubleshooting**: Common issues and solutions
 
-## 🚀 Quick Start
+## Quick Start
 
 ### Prerequisites
 
@@ -33,207 +32,3 @@ This documentation covers everything you need to know to install and use Monodog
    ```
 
 3. Open browser to `http://localhost:3001`
-
-### Build Production Version
-
-```bash
-npm run build
-```
-
-This generates static HTML in the `build/` directory that can be deployed to any static hosting.
-
-## 📁 Project Structure
-
-```
-docs/
-├── docs/                          # Documentation content
-│   ├── intro.md                   # Introduction page
-│   ├── getting-started/           # Getting started guides
-│   ├── installation/              # Installation guides
-│   ├── features/                  # Features documentation
-│   ├── api-reference/             # API documentation
-│   ├── future-section/            # Future Enhancements
-│   └── troubleshooting/           # Troubleshooting guides
-├── src/
-│   └── css/
-│       └── custom.css             # Custom styles
-│       └── monodog.css            # fontpage styles
-├── static/                        # Static assets (images, etc)
-├── docusaurus.config.js          # Docusaurus configuration
-├── sidebars.js                   # Sidebar structure
-└── package.json                  # Project configuration
-```
-
-## 📝 Adding New Documentation
-
-1. Create a new `.md` file in the appropriate `docs/` subdirectory
-2. Add frontmatter with title and sidebar position:
-   ```markdown
-   ---
-   sidebar_position: 1
-   title: Your Page Title
-   ---
-   
-   # Page Content
-   ```
-3. Update `sidebars.js` if adding a new section
-4. Pages automatically appear in the sidebar!
-
-## 🔗 Available Commands
-
-| Command | Description |
-|---------|-------------|
-| `npm start` | Start dev server on port 3001 |
-| `npm run build` | Build static site |
-| `npm run serve` | Serve built site |
-| `npm run clear` | Clear cache |
-| `npm run swizzle` | Customize Docusaurus theme |
-
-## 🌐 Deployment
-
-### Build
-```bash
-npm run build
-```
-
-### Deploy to GitHub Pages
-```bash
-npm run deploy
-```
-
-### Deploy to Static Hosting
-Copy the `build/` folder to your static hosting service (Vercel, Netlify, GitHub Pages, etc.)
-
-## 📖 Documentation Content
-
-### 30 Documentation Files Created
-
-- **Getting Started** (3 files)
-  - Overview
-  - Prerequisites
-  - Quick Start
-
-- **Installation** (4 files)
-  - NPM Installation
-  - Monorepo Configuration
-  - Environment Setup
-  - First Run
-
-- **Usage** (4 files)
-  - Dashboard Guide
-  - Available Commands
-  - Configuration
-  - Examples
-
-- **Features** (5 files)
-  - Package Scanning
-  - Health Monitoring
-  - CI Integration
-  - Dependency Analysis
-  - Git Integration
-
-- **API Reference** (5 files)
-  - API Overview
-  - Packages Endpoint
-  - Health Endpoint
-  - Commits Endpoint
-  - Config Endpoint
-
-- **Advanced** (4 files)
-  - Custom Configuration
-  - Database Setup
-  - Security
-  - Performance
-
-- **Troubleshooting** (4 files)
-  - Common Issues
-  - FAQ
-  - Debug Mode
-  - Getting Support
-
-## 🎨 Customization
-
-### Colors and Theme
-
-Edit `src/css/custom.css` to customize colors:
-
-```css
-:root {
-  --ifm-color-primary: #2e8555;
-  --ifm-color-primary-light: #33925d;
-}
-```
-
-### Configuration
-
-Edit `docusaurus.config.js` to change:
-- Site title and tagline
-- Base URL and deployment
-- Navbar and footer links
-- Branding and metadata
-
-## 🔍 Search
-
-The documentation includes built-in search functionality powered by Docusaurus.
-
-## 📱 Mobile Responsive
-
-The documentation is fully responsive and works perfectly on mobile devices.
-
-## 🌙 Dark Mode
-
-Automatic dark mode support with theme toggle in navbar.
-
-## ✅ Features
-
-- ✅ Full-text search
-- ✅ Dark mode support
-- ✅ Mobile responsive
-- ✅ SEO optimized
-- ✅ Syntax highlighting
-- ✅ Sidebar navigation
-- ✅ Breadcrumbs
-- ✅ Edit links
-- ✅ Table of contents
-
-## 📄 License
-
-Same as Monodog project
-
-## �� Contributing
-
-To contribute to the documentation:
-
-1. Edit or create `.md` files in `docs/`
-2. Update `sidebars.js` if needed
-3. Test locally with `npm start`
-4. Submit a pull request
-
-## 📚 Technology Stack
-
-- **Docusaurus**: Documentation generator
-- **React**: UI framework
-- **MDX**: Markdown + React
-- **Tailwind CSS**: Styling (via custom CSS)
-- **Prism**: Syntax highlighting
-
-## 🆘 Support
-
-For issues with the documentation:
-
-1. Check [Troubleshooting](/troubleshooting/common-issues)
-2. Review [FAQ](/troubleshooting/faq)
-3. Open an issue on GitHub
-4. Check discussions
-
-## 📊 Statistics
-
-- **Total Files**: 30 markdown files
-- **Total Content**: ~10,000+ words
-- **Build Size**: 2.0 MB
-- **Pages**: 30+
-- **Code Examples**: 50+
-
----
-
-**Built with ❤️ for developers by developers**

documentation/docs/getting-started/quick-start.md

@@ -27,7 +27,7 @@ cd monodog
 Run Monodog application:
 
 ```bash
-npm run serve
+pnpm serve
 ```
 
 You should see output like:

documentation/docs/installation/first-run.md

@@ -18,7 +18,7 @@ cd monodog
 Run Monodog application:
 
 ```bash
-npm run serve
+pnpm serve
 ```
 
 You should see output like:

documentation/docs/intro.md

@@ -43,7 +43,7 @@ Monodog provides a REST API for access to all its features. It is already integr
 Install Monodog in your monorepo:
 
 ```bash
-pnpm install --save-dev @mindfiredigital/monodog -w
+pnpm dlx @mindfiredigital/monodog
 ```
 Go to the monodog directory that was created after the installation.
 
@@ -54,7 +54,7 @@ cd monodog
 Run the dashboard and API:
 
 ```bash
-npm run serve
+pnpm serve
 ```
 
 Visit the dashboard at http://localhost:3010 to begin monitoring your monorepo.

documentation/docusaurus.config.js

@@ -3,15 +3,15 @@ const { themes } = require('prism-react-renderer');
 
 /** @type {import('@docusaurus/types').Config} */
 const config = {
-  title: 'Monodog',
+  title: 'MonoDog',
   tagline: 'Monorepo Analytics and Health Dashboard API',
   favicon: 'img/favicon.ico',
 
   url: 'https://mindfiredigital.github.io',
-  baseUrl: '/monodog',
+  baseUrl: '/MonoDog',
 
   organizationName: 'mindfiredigital',
-  projectName: 'monodog',
+  projectName: 'MonoDog',
   deploymentBranch: 'main',
 
   onBrokenLinks: 'warn',
@@ -29,7 +29,7 @@ const config = {
         docs: {
           sidebarPath: './sidebars.js',
           routeBasePath: '/',
-          editUrl: 'https://github.com/mindfiredigital/monodog/tree/main/docs',
+          editUrl: 'https://github.com/mindfiredigital/MonoDog/tree/main/documentation',
         },
         blog: false,
         theme: {
@@ -42,7 +42,7 @@ const config = {
   themeConfig: {
     // image: 'img/monoapp-social-card.jpg',
     navbar: {
-      title: 'Monodog',
+      title: 'MonoDog',
       logo: {
         alt: 'Monodog Logo',
         src: 'img/logo.jpg',
@@ -55,61 +55,12 @@ const config = {
           label: 'Docs',
         },
         {
-          href: 'https://github.com/mindfiredigital/monodog',
+          href: 'https://github.com/mindfiredigital/MonoDog',
           label: 'GitHub',
           position: 'right',
         },
       ],
     },
-    // footer: {
-    //   style: 'dark',
-    //   links: [
-    //     {
-    //       title: 'Docs',
-    //       items: [
-    //         {
-    //           label: 'Getting Started',
-    //           to: '/getting-started/overview',
-    //         },
-    //         {
-    //           label: 'Installation',
-    //           to: '/installation/install-npm',
-    //         },
-    //         {
-    //           label: 'API Reference',
-    //           to: '/api-reference/overview',
-    //         },
-    //       ],
-    //     },
-    //     {
-    //       title: 'Community',
-    //       items: [
-    //         {
-    //           label: 'GitHub Discussions',
-    //           href: 'https://github.com/monodog/monoapp/discussions',
-    //         },
-    //         {
-    //           label: 'GitHub Issues',
-    //           href: 'https://github.com/monodog/monoapp/issues',
-    //         },
-    //       ],
-    //     },
-    //     {
-    //       title: 'Resources',
-    //       items: [
-    //         {
-    //           label: 'GitHub Repository',
-    //           href: 'https://github.com/monodog/monoapp',
-    //         },
-    //         {
-    //           label: 'NPM Package',
-    //           href: 'https://www.npmjs.com/package/@monodog/monoapp',
-    //         },
-    //       ],
-    //     },
-    //   ],
-    //   copyright: `Copyright © ${new Date().getFullYear()} Monodog. Built with Docusaurus.`,
-    // },
     prism: {
       theme: themes.github,
       darkTheme: themes.dracula,

package.json

@@ -31,14 +31,14 @@
   "devDependencies": {
     "@changesets/changelog-github": "^0.5.2",
     "@changesets/cli": "^2.29.8",
-    "@commitlint/cli": "^17.8.1",
+    "@commitlint/cli": "^20.3.1",
     "@commitlint/config-conventional": "^17.8.1",
     "@types/body-parser": "^1.19.6",
     "@types/node": "^20.19.30",
-    "@typescript-eslint/eslint-plugin": "^8.53.0",
+    "@typescript-eslint/eslint-plugin": "^8.53.1",
     "eslint": "^8.57.1",
     "husky": "^8.0.3",
-    "lint-staged": "^14.0.1",
+    "lint-staged": "^16.2.7",
     "prettier": "^3.8.0",
     "tsx": "^4.21.0",
     "turbo": "^1.13.4",

packages/monoapp/README.md

@@ -2,7 +2,7 @@
 
 ## Overview
 
-The dashboard will provide visual management and monitoring capabilities for packages in monorepos using pnpm and turbo. It will be distributed as an npm package installable in any monorepo to auto-generate a web UI for package oversight.
+Monodog provides visual management and monitoring capabilities for packages in monorepos using pnpm and Turbo. It is distributed as an npm package that can be installed in any monorepo to automatically generate a web UI for package oversight.
 
 This service is typically run locally or on a central server and power a dedicated frontend dashboard.
 <img width="1593" height="807" alt="package-scan" src="https://github.com/user-attachments/assets/d7e86b80-9f6a-4608-9103-68e6d660cc36" />