Skip to content

TirthDhandhukia30/readDocs

Repository files navigation

readDocs

Navigate official documentation with clarity, order, and correctness.

Overview

readDocs is a structured learning path navigator that helps you master major tech domains by guiding you through official documentation in the correct order. No rewrites, no third-party tutorials—just the right docs in the right sequence.

Supported Domains

  • Web Development - HTML, CSS, JavaScript, TypeScript, React, Next.js, Node.js
  • Mobile Development - Swift, SwiftUI, Kotlin, Jetpack Compose, React Native, Flutter
  • Web3 - Blockchain fundamentals, Solidity, Smart Contracts, ethers.js/viem, DeFi
  • AI & Machine Learning - Python, NumPy, Pandas, Scikit-learn, PyTorch, TensorFlow, Hugging Face

Tech Stack

Getting Started

# Install dependencies
npm install

# Start development server
npm run dev

# Build for production
npm run build

# Preview production build
npm run preview

Guiding Principles

  1. Official Sources Only - Every link points to official documentation
  2. Strict Dependency Order - Clear prerequisites for each step
  3. No Tool Hype - Focus on what matters for learning
  4. Clear Mental Models - Build correct understanding from the ground up

Features

  • 🎯 Domain-based learning paths
  • 📊 Progress tracking with local storage
  • 🔍 Universal search across all documentation
  • ⌨️ Keyboard shortcuts for power users
  • 🌙 Dark mode support
  • 📱 Fully responsive design

License

MIT

About

Navigate official documentation with clarity, order, and correctness.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages