Go give a ⭐ to Open DeepLearning on GitHub!

Contributing to the Guide

Open DeepLearning is a collaborative open-source community committed to improving the accessibility of AI education for all. Join us in our collaborative effort to expand the frontiers of knowledge and promote inclusivity in the field of artificial intelligence. Be a part of shaping a future where learning transcends limits. Your contributions are valued and welcomed!

Contribute to the guide by:

  • Enrich Content Repository: Diversify the repository with new AI content and enhance existing resources for a comprehensive collection.
  • User-Centric Refinement: Address typos or broken links to ensure a smooth user experience.
  • Design for Impact: Enhance the overall structure, formatting, or design for improved accessibility.
  • Suggest new topics: Propose fresh ideas or resources by opening an issue (opens in a new tab) and suggesting new topics.
  • Translation Assistance: Help make content more accessible by translating the site into various languages. Express interest on Discord or by pushing the repository. Refer to Next.js i18n (opens in a new tab) docs for guidance.

Guidelines for Contributors

  • Clarity is Key: Ensure that the language used in blogs and content is simple and easily understandable, making the information accessible to a broad audience.
  • Image Usage Etiquette: If your contribution includes a blog post (opens in a new tab) with images sourced from someone else, always provide proper attribution by mentioning the image source. This ensures transparency and respect for intellectual property.

Running the guide locally

Fork the GitHub repository and clone it locally

Prerequisites

Before you start, make sure you have the following:

git clone https://github.com/severus27/OpenML-Guide.git

Install the dependencies.

Install all the libraries used in the guide.

pnpm install

Start the development server

To run the guide locally on your computer, initiate the server, which will start at port 3000 (opens in a new tab).

pnpm dev

Contributing using Edit page button

If running the guide locally seems complex, you can still contribute or edit by using the Edit this page button on the right side of the page—it's straightforward with Markdown.