Skip to content

CodeCompasss/gecian_docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

6 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Gecian Hub Documentation

Welcome to the official documentation of Gecian Hub.
This repository contains all the guides, tutorials, and technical references for the Gecian Hub project.


πŸ“Œ About Gecian Hub

Gecian Hub is a student-focused platform designed to help college students:

  • Access useful learning resources
  • Showcase and collaborate on projects
  • Participate in beginner-friendly open-source contributions

The goal is to make learning, contributing, and collaborating simple and structured.


🧭 Documentation Overview

The documentation is organized as follows:

  • Introduction: Background, goals, mission, and values of Gecian Hub
  • Setup: Local environment setup, Firebase, Neon, Git workflow
  • Organization: Structure and roles of the community
  • Architecture: Technical overview and technology stack
  • Community: Guidelines, contribution guides, Hacktoberfest info
  • Succession: Onboarding and succession planning
  • Roadmap: First-year journey, future plans, lessons learned

πŸš€ How to Use

  1. Clone the repository:
git clone https://github.com/GEC-SKP-DEV/gecian_docs.git
  1. Install MkDocs and dependencies:
pip install mkdocs mkdocs-material
  1. Serve the documentation locally:
mkdocs serve
  1. Open your browser at http://127.0.0.1:8000

  2. To deploy to GitHub Pages:

mkdocs gh-deploy