Skip to content

alafilearnstocode/DISC-Documentation-Website

 
 

Repository files navigation

DISC Documentation Website

Welcome to the DISC Documentation Website! This project is built using Docusaurus, a modern static site generator, to provide detailed and organized documentation for DISC's three main projects.


Table of Contents

  1. About
  2. Projects
  3. Getting Started
  4. Contributing
  5. License

About

The DISC Documentation Website serves as a central hub for all resources, guidelines, and information related to DISC's key initiatives. It is designed to streamline collaboration and provide clear instructions for contributors and team members.

Features

  • Comprehensive guides for each project
  • Consistent and accessible documentation structure
  • Custom styling for DISC branding

Projects

DISC Website

The DISC Website project documentation includes:

  • Components overview
  • Contribution guidelines
  • Deployment instructions
  • Styling standards
  • Project structure breakdown

For more details, visit the DISC Website docs.


Discover Program Template Project

The Discover Program Template Project provides a template for creating program-specific websites. Documentation covers:

  • Introduction and purpose
  • Setup instructions

For more details, visit the Discover Program Template Project docs.


Workshop Series

The Workshop Series documentation focuses on providing resources for running technical workshops. It includes:

  • Installation and setup instructions
  • Quick start guides
  • Contribution guidelines
  • Project structure overview

For more details, visit the Workshop Series docs.


Getting Started

To run the project locally:

  1. Clone the repository:

    git clone <repository-url>
    cd <repository-directory>
  2. Install dependencies:

    npm install
  3. Start the development server:

    npm start
  4. Open your browser to http://localhost:3000 to view the website.

For more setup instructions, see Getting Started.


Contributing

We welcome contributions to this project! To get started:

  1. Review the contribution guidelines in each project's contributing.md file.
  2. Fork the repository and create a new branch for your changes.
  3. Submit a pull request for review.

Refer to the Contributing Guide for detailed instructions.


License

This project is licensed under MIT License. See the license file for details.


If you have any questions or need assistance, please contact the DISC team or open an issue in the repository. 🎉

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • TypeScript 87.2%
  • CSS 12.8%