DocsLab

The ultimate open-source developer knowledge hub for students and contributors.

Start Here · Documentation · Contributor Hub · Open Issues

---

📖 About The Project

DocsLab is an open-source initiative built by Android Club VIT Bhopal.

Our primary goal is to preserve, organize, and share high-quality technical knowledge. By building a comprehensive student developer ecosystem, we want to help beginners take their first steps into open source while providing advanced resources for experienced developers. Whether you're learning to center a div, mastering prompt engineering, or making your first pull request, DocsLab is here to help.

✨ Features

• 📘 Open-source contributor guides: Learn Git, GitHub, and OSS etiquette.
• 🤖 Prompt engineering resources: Unlock the power of LLMs.
• 📱 Android development docs: Master native and cross-platform mobile dev.
• 🌐 Web development docs: React, Next.js, and modern tooling.
• ⌨️ GitHub workflows & shortcuts: Boost your productivity.
• 📄 MDX-powered documentation: Rich, interactive content.
• 🔍 Search support: Find what you need instantly.
• 🌙 Dark mode: Beautiful themes tailored for developers.
• 📱 Responsive design: Flawless experience on all devices.
• 🤝 Community-driven content: Built by students, for students.

🛠 Tech Stack

Frontend

• Next.js 15 - React framework for the web
• TypeScript - Strongly typed JavaScript
• TailwindCSS v4 - Utility-first CSS framework

Documentation

• Fumadocs - Next-generation documentation framework
• MDX - Markdown for the component era

Tooling

• ESLint & Prettier - Code quality and formatting
• Husky & Lint-Staged - Git hooks automation
• GitHub Actions - Robust CI/CD pipelines

📁 Project Structure

.
├── .github/             # GitHub Actions workflows and issue templates
├── content/             # MDX documentation files and collections
│   └── docs/            # Categorized learning tracks and guides
├── public/              # Static assets (images, fonts, etc.)
├── src/                 # Application source code (Next.js app router)
│   ├── app/             # App routing and layouts
│   ├── components/      # Reusable UI components
│   └── lib/             # Utility functions and shared config
├── package.json         # Project dependencies and scripts
└── README.md            # You are here!

🚀 Getting Started

Follow these steps to set up the project locally on your machine.

Prerequisites

• Node.js (v18 or higher)
• Git
• npm (Node Package Manager)

Installation

1. Clone the repository:

   git clone https://github.com/androidclubvitbhopal/DocsLab.git
   cd DocsLab

2. Install dependencies:

   npm install

3. Run the development server:

   npm run dev

4. Open your browser: Navigate to http://localhost:3000 to see the application running.

🤝 Contribution Guide

We ❤️ contributions! Whether it's a typo fix, a new tutorial, or a feature enhancement, your help is welcome.

1. Fork the repository to your GitHub account.
2. Create a branch for your feature or bug fix:

   git checkout -b feat/your-awesome-feature

3. Commit your changes following Conventional Commits:

   git commit -m "feat: added prompt engineering guide"

4. Push your branch to your fork:

   git push origin feat/your-awesome-feature

5. Open a Pull Request against our main branch.

💡 Looking for a place to start?

Check out our good first issues or filter by the beginner label. Please review our CONTRIBUTING.md for full guidelines on contribution etiquette.

📝 Contributing Documentation

You do not need to know React, Next.js, or advanced development concepts to contribute to DocsLab.

If you can write technical content, fix typos, improve explanations, or share knowledge, you can contribute.

📖 Documentation Contribution Guide: Documentation Contribution Guide

📄 Documentation Template: DOC_TEMPLATE.mdx

New to open source? Start with documentation contributions. Most DocsLab pages are written using simple MDX (Markdown + components), and our guide will walk you through everything you need.

📚 Documentation Sections

Our knowledge base is divided into several key learning tracks:

• Start Here - Quick guide to navigate the docs.
• Open Source - Essential guides on Git, GitHub, and contributing.
• Contributor Hub - Rules and guidelines for contributing to DocsLab.
• Android Development - Guides and tutorials for mobile development.
• Web Development - Frontend and backend web technologies.
• Prompt Engineering - Learn to communicate with AI.
• Productivity & Shortcuts - IDE and tool productivity tips.
• Projects - Android Club VITB initiatives and community projects.

⚙️ GitHub Workflow

To maintain high code and content quality, we enforce the following workflows:

• CI Checks: Every PR runs through automated formatting, linting, type-checking, and MDX validation.
• Branch Protections: The main branch is protected. Code can only be merged via Pull Requests.
• PR Reviews: At least one maintainer review is required before merging.
• Conventional Commits: We enforce semantic commit messages via Husky hooks.

💬 Community & Support

Join our community to ask questions, share your work, and connect with other developers!

• 👾 Discord: Join our Server (Link coming soon)
• 💡 GitHub Discussions: Ask questions or share ideas
• 🐛 Issues: Report bugs or request features
• 🏢 Organization: Android Club VIT Bhopal

🗺 Roadmap

We have exciting plans for the future of DocsLab:

• AI-powered docs search and chat
• Interactive in-browser coding tutorials
• Structured learning tracks and pathways
• Contributor leaderboard
• Community articles and blog posts
• Enhanced search improvements

💎 Contributors

A massive thank you to everyone who has contributed to this project!

📜 License

This project is licensed under the MIT License.

🛡 Maintainers

Android Club VITB Core Team

---

Built with ❤️ by Android Club VIT Bhopal