Git Product home page Git Product logo

technologies's Introduction

Technologies

Repo to handle submitting & updating technologies on lablab.ai

πŸ‘‰ How to publish a new technology on lablab

In this guide you will learn how to publish technology pages on lablab.

General information

If you want to publish a new technology on lablab.ai, follow these steps:

  1. Create a folder for the technology you're adding in this GitHub repository: https://github.com/lablab-ai/technologies
  2. Here create the folder, and create a file named 'index.mdx' for the technology.
  3. 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 technology provider page

  1. 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.

title index

table index

πŸ‘‰ Create a page for a specific technology

  1. 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.
  2. 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.

title technology

table technology

start building with the technology

boilerplates and libraries

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.

How to add page?

  1. Write it!
  2. 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

technologies's People

Contributors

emmiriarte avatar ezzcodeezzlife avatar flafi87 avatar ircocojambo avatar jmisilo avatar mikayelh avatar zakrz avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

technologies's Issues

Add Plagiarism Checking

Describe the AI technology or improvement you'd like
A clear and concise description of the AI technology you want to be added or the improvement you'd like to see in the existing technology.

Describe how this AI technology can be integrated into the project
Explain how this technology can be used or integrated within the project and how it will benefit the users.

Describe alternatives you've considered
A clear and concise description of any alternative AI technologies or features you've considered.

Additional context
Add any other context, research, or screenshots about the AI technology feature request here.

Test Algora.io bounty program

Describe the AI technology or improvement you'd like
A clear and concise description of the AI technology you want to be added or the improvement you'd like to see in the existing technology.

Describe how this AI technology can be integrated into the project
Explain how this technology can be used or integrated within the project and how it will benefit the users.

Describe alternatives you've considered
A clear and concise description of any alternative AI technologies or features you've considered.

Additional context
Add any other context, research, or screenshots about the AI technology feature request here.

Github Actions

Improvements to Github Actions

  • Should only push files changed in the commit.
  • Should check for Plagiarism & AI generated content.
  • Uses copyleaks API, Request login / API key from @Mindgames
  • Files to be found in .github/ folder

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.