PyDoctor • Documentation & Landing Page

The official documentation and high-performance landing page for PyDoctor — the autonomous diagnostic engine for Python clusters. This repository hosts the developer-facing web presence designed with a premium, high-fidelity technical aesthetic.

---

🏗 Architecture & Design System

This project is built using a modern, reactive stack focused on performance and developer experience:

• Core Framework: Next.js 14+ with App Router.
• Styling: Tailwind CSS utilizing a custom technical design system (Grids, Glassmorphism, and Mono-typography).
• Animations: Framer Motion for high-performance scroll reveals, terminal simulations, and interactive components.
• Icons: Lucide React for lean, consistent iconography.
• Type Safety: TypeScript for enterprise-grade robustness.

🚀 Key Features

1. High-Fidelity Landing Page

• Diagnostic Terminal Demo: An interactive terminal mockup showing real-time scanning heuristics.
• Technical Marquee: High-speed, responsive scroll-marquee highlighting core capabilities.
• Grid Mesh Background: Proprietary grid and dot-pattern system for a deep-space technical feel.

2. Integrated Documentation

• Dynamic Sidebar: Responsive navigation with real-time search indexing.
• Internal Anchor Routing: Instant, non-redirecting navigation for a single-page app feel.
• Cross-Manager Support: Detailed guides for pip, poetry, pdm, and uv.

3. SEO & Performance

• Full OpenGraph and Twitter card support for premium link previews.
• Optimized font loading via next/font.
• Server-side rendering (SSR) for lightning-fast initial paints.

---

🛠 Getting Started

Prerequisites

• Node.js (v18+)
• pnpm (Recommended)

Installation

1. Clone the repository:

   git clone https://github.com/iamAgbaCoder/pydoctor-docs.git
   cd pydoctor-docs

2. Install dependencies:

   pnpm install

3. Launch development server:

   pnpm dev

The application will be available at http://localhost:3000.

---

🤝 Contributing

We welcome contributions to the PyDoctor web presence!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git checkout -b feature/AmazingFeature)
5. Open a Pull Request

📄 License

Distributed under the MIT License. See LICENSE for more information.

---

Built with 🧡 by iamAgbaCoder