Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reorganize Guides in a more logical order #8262

Merged
merged 10 commits into from May 13, 2024
Merged

Reorganize Guides in a more logical order #8262

merged 10 commits into from May 13, 2024

Conversation

abidlabs
Copy link
Member

@abidlabs abidlabs commented May 11, 2024

The ordering of the Guides currently doesn't make sense, as we introduce gr.Interface in the Quickstart, then cover all sorts of key features that are quite advanced, and then lots of details related to sharing, before jumping back to gr.Interface.

Now, I think the ordering makes more sense. These are the new sections

  1. Quickstart
  2. Interface
  3. Additional Features (key features and sharing details moved here. I've also separated key features into individual guides since we should add more details to these guides -- will do in a separate pr -- and also for seo purposes)
  4. Blocks
  5. ChatInterface and Chatbots
  6. Custom Components
  7. Tabular DS and Plots
  8. Clients and Lite
  9. Other Tutorials (moved integrations to this section)

I've also fixed some typos, etc. I want to rework the guides some more but I didn't want to mix refactoring & other changes in a single PR.

@gradio-pr-bot
Copy link
Contributor

gradio-pr-bot commented May 12, 2024

🪼 branch checks and previews

Name Status URL
Spaces ready! Spaces preview
Website failed! Details
Storybook ready! Storybook preview
🦄 Changes detecting...

Install Gradio from this PR

pip install https://gradio-builds.s3.amazonaws.com/9902084af09803564bfab74c98154460314aa7f9/gradio-4.31.0-py3-none-any.whl

Install Gradio Python Client from this PR

pip install "gradio-client @ git+https://github.com/gradio-app/gradio@9902084af09803564bfab74c98154460314aa7f9#subdirectory=client/python"

@gradio-pr-bot
Copy link
Contributor

gradio-pr-bot commented May 12, 2024

🦄 change detected

This Pull Request includes changes to the following packages.

Package Version
website minor
  • Maintainers can select this checkbox to manually select packages to update.

With the following changelog entry.

Reorganize Guides in a more logical order

Maintainers or the PR author can modify the PR title to modify this entry.

Something isn't right?

  • Maintainers can change the version label to modify the version bump.
  • If the bot has failed to detect any changes, or if this pull request needs to update multiple packages to different versions or requires a more comprehensive changelog entry, maintainers can update the changelog file directly.

@abidlabs abidlabs marked this pull request as ready for review May 12, 2024 02:40
@abidlabs abidlabs requested a review from aliabd May 12, 2024 02:40
Copy link
Collaborator

@aliabd aliabd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! I agree this is much better.

Can you add redirect routes for old links? Not a big deal but can be helpful https://github.com/gradio-app/gradio/blob/main/js/_website/src/routes/redirects.js

@abidlabs
Copy link
Member Author

Is it needed, I thought moving the guides to different sections does not affect the url, e.g. https://www.gradio.app/guides/the-interface-class

@aliabd
Copy link
Collaborator

aliabd commented May 13, 2024

yeah you're right, i meant for the ones you removed, which i guess is just key-features

@abidlabs
Copy link
Member Author

right, will add

@abidlabs abidlabs enabled auto-merge (squash) May 13, 2024 20:04
@abidlabs
Copy link
Member Author

Thanks @aliabd for the review!

@abidlabs abidlabs merged commit d708ca8 into main May 13, 2024
8 checks passed
@abidlabs abidlabs deleted the guides-reorg branch May 13, 2024 20:13
@pngwn pngwn mentioned this pull request May 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants