Skip to content

Latest commit

 

History

History
58 lines (35 loc) · 3.57 KB

README.md

File metadata and controls

58 lines (35 loc) · 3.57 KB
Raw

AI Tutorials

Repo to handle submitting & updating tutorials on lablab.ai

How to publish a new tutorial on lablab.ai

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

General information

  • Check out the tutorial 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!
  • Make sure the tutorial has a clear structure. Use a minimum of three H2 headings, including one for the introduction, another for the topic input, and the last one to summarize all previously discussed points. Additionally, use H3 subheadings for every significant point you cover.
  • The tutorial you create should relate to one of the technologies listed in the lablab database. Or, make sure to add the technology you are using to the AI Tech page, in case it's not there.

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

  1. Make sure you have created your profile on lablab.ai and filled in the profile information - that will help community readers get to know the author of the tutorial 😉

  2. Create an mdx file for the tutorial with the tutorial title in slug format (you can slugify here) as the filename in this GitHub repository: https://github.com/lablab-ai/community-content/tree/main/tutorials

  3. Please keep in mind we might change the filename and title of the tutorial to make it more SEO friendly.

  4. For each tutorial page, include the following information:

    • title: Title of the tutorial
    • description: Description of the tutorial
    • authorUsername: Your username on lablab.ai

tutorial title, description, and author

Upload images to this service and provide a like that looks like: https://iili.io/HPaF59p.png

  1. You can use one of our tutorial page as a template or the template file in this repo to create your own tutorial page.

  2. To add image use the <Img src={path_to_your_img}, alt={img_alt}, caption={short_img_caption_below_it}/> component.

  3. After you create a PR we will check the tutorial content and merge it if everything is fine.

Finally, visit our GitHub repo and add AI tutorials here, get inspiration from the existing pages when creating your own: https://github.com/lablab-ai/community-content/tree/main/tutorials.

How to add page?

  1. Write it!
  2. Create two pull requests:
    • to community-content branch - thanks to that our internal system will be able to check if your files contains plagiarism/AI generated content (required)
    • to main branch

Adding as sponsored content/Adding sponsored image

  1. To add sponsor as author and link to the sponsor website add to the top of the file under the mandatory fields:

    • sponsor: Sponsored by ...
    • sponsorUrl: https://...

Keep in mind still you have to add a valid authorUsername!

  1. To place a sponsor image inside the post --> add <SponsoredContentImage url="https://linktosponsor.com" imageUrl="https://sponsor/linktosponsorlogo.jpg"/> somewhere in the tutorial