mirror/gradio
2
0
Fork 0
mirror of https://github.com/gradio-app/gradio.git synced 2024-12-21 02:19:59 +08:00
Code Issues Packages Projects Releases Wiki Activity
12e733360e
gradio/guides/README.md
Abubakar Abid 90c28eae46
Guides fixes (#565) 
* fixed guides; added contributing guidelines

* updated guide contributing

* fixed flagging guide

* updated organization of readme files

* fixed and brought back readme_template

Co-authored-by: aliabd <ali.si3luwa@gmail.com>
2022-02-09 20:33:16 +04:00

2.0 KiB
Raw Blame History

Contributing a Guide

Want to help teach Gradio? Consider contributing a Guide! 🤗

Broadly speaking, there are two types of guides:

  • Use cases: guides that cover step-by-step how to build a particular type of machine learning demo or app using Gradio. Here's an example: Creating a Chatbot
  • Feature explanation: guides that describe in detail a particular feature of Gradio. Here's an example: Using Flagging

We encourage you to submit either type of Guide! (Looking for ideas? We may also have open issues where users have asked for guides on particular topics)

Guide Structure

As you can see with the previous examples, Guides are standard markdown documents. They usually:

  • start with an Introduction section describing the topic
  • include subheadings to make articles easy to navigate
  • include real code snippets that make it easy to follow along and implement the Guide
  • include embedded Gradio demos to make them more interactive and provide immediate demonstrations of the topic being discussed. These Gradio demos are hosted on Hugging Face Spaces and are embedded using the standard <iframe> tag.

How to Contribute a Guide

  1. Clone or fork this gradio repo
  2. Add a new markdown document with a descriptive title to the /guides folder
  3. Write your Guide in standard markdown! Embed Gradio demos wherever helpful
  4. Add a list of related_spaces at the top of the markdown document (see the previously linked Guides for how to do this)
  5. Add 3 tags at the top of the markdown document to help users find your guide (again, see the previously linked Guides for how to do this)
  6. Open a PR to have your guide reviewed

That's it! We're looking forward to reading your Guide 🥳