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

Update docs for easier quickstart #544

Merged
merged 4 commits into from
Aug 6, 2024

Conversation

komyg
Copy link
Contributor

@komyg komyg commented Jul 21, 2024

Description

I made a few changes to the docs, to make them better and more user-friendly:

Add Quickstart to the Sidebar

The quickstart document was not on the sidebar, so navigating to it was only possible from the first page, and once you were there, you could not go to any other page.

I've changed that by adding the Getting started item in the sidebar, under the Run a model section.

Furthermore, I recommend you change the order of the sections so that Run a model is the first one, because this is what I, as a user, was immediately looking for, when I opened this page. However, I did not include this change in this PR, since it is a big change to your documentation.

Updated Quickstart Code

I have changed the quickstart example code that visualizes the results, so that the user does not have to download the people walking image.

My reasons for proposing this change are:

  • The documentation does not explicitly say that the user must download the image before running the code.
  • Furthermore, I as a user, would expect the quickstart code to run immediately after copying and pasting it, especially because the previous code ran exactly like that, so I would expect that pasting over the previous code would immediately work.

Add Explicit Warn to CogVLM

I added an explicit warning regarding running CogVLM, because even though my computer has a GPU, it is not an NVidia GPU, so I assumed that CogVLM would run, but that was not the case.

Docs

  • Docs updated? What were the changes: updated the quickstart example code, so that it does not require the user to download the people walking image.

@CLAassistant
Copy link

CLAassistant commented Jul 21, 2024

CLA assistant check
All committers have signed the CLA.

@komyg komyg changed the title Update quickstart docs for easier start Update docs for easier quickstart Jul 21, 2024
Copy link
Contributor

@capjamesg capjamesg left a comment

Choose a reason for hiding this comment

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

Looks good!

@komyg
Copy link
Contributor Author

komyg commented Jul 24, 2024

Hi @capjamesg, I can't merge this unless the checks have ran, but I don't know how to trigger them. Could you help?

@PawelPeczek-Roboflow PawelPeczek-Roboflow merged commit 8236922 into roboflow:main Aug 6, 2024
25 of 55 checks passed
@komyg komyg deleted the update-quickstart-docs branch August 6, 2024 11:35
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.

4 participants