Repo to handle submitting & updating technologies on lablab.ai
In this guide you will learn how to publish technology pages on lablab.
- Check out the technology page template
- Please don’t copy the content from other websites!
- Please don’t use AI content generators to create the content for this page!
If you want to publish a new technology on lablab.ai, follow these steps:
- Create a folder for the technology you're adding in this GitHub repository: https://github.com/lablab-ai/technologies
- Here create the folder, and create a file named 'index.mdx' for the technology.
- If you're adding multiple technologies from the same provider, create a folder with the provider's name, and include an 'index.mdx' file that describes the provider, as well as separate pages for each technology they offer. You can find a good example of this in the OpenAI folder of our GitHub repo.
- Create a page for the technology provider that includes the following information:
- Title: Same as the provider's name.
- Description: A brief (88-158 characters) description that includes one main keyword related to the provider (e.g., "OpenAI").
- Table: Start with a heading (H1) that includes the company name, description, and the date it was founded. If the provider has a public repository, include a link to it.
- Start building with provider's products: Create a heading (H2) that says "Start building with [Provider's] products" and write a short introduction (at least two sentences) about the company's products. End with a sentence that encourages readers to check out the apps created with this technology during lablab.ai hackathons.
- List the products: Use the heading (H2) for the technology, and include a short description and a link to its page.
- If you're adding only one technology, use the index file for the technology. If you're adding multiple products, create a separate page for each technology using its name as the title.
- For each technology page, include the following information:
- Author: Name of the provider (e.g., 'author="OpenAI"').
- Table: Include the release date, author, link to documentation, link to the public GitHub repository, and the type of technology you're adding.
- Start building with the technology section: Create a heading (H2) that says "Start building with [Technology]" and write a short description of the technology. End with a sentence that encourages readers to check out the community-built use cases and applications.
- Below, please remember to include
<TechTutorials/>
component that will automatically link the tutorials on lablab relevant to the technology. - Links, Libraries, Boilerplates, and Resources: Include relevant resources to help others start building with the technology. Create separate sections for links, libraries, boilerplates, and other resources. Use H3 headings.
Finally, visit our GitHub repo and add AI technologies here, get inspiration from the existing pages when creating your own: https://github.com/lablab-ai/technologies.
- Write it!
- Create two pull requests:
- to
technologies
branch - thanks to that our internal system will be able to check if your files contains plagiarism/AI generated content (required) - to
main
branch
- to