Skip to content

Conversation

capjamesg
Copy link
Contributor

@capjamesg capjamesg commented Jul 15, 2025

Description

This PR contains several improvements to the Inference documentation.

The philosophy for this change maps to our strategy to be Workflows-first. Running a model should be a one-block Workflow. Users should be able to build complex, multi-stage Workflows as easily as possible.

The following changes have been made:

  • The Start section has been re-written and refactored. The goal is to get someone to a trained model as fast as possible. With this in mind, the introduction material is now condensed into one page, and the second link on the page is a new quickstart tutorial that gets someone using Workflows on images and their webcam in five minutes.
Screenshot 2025-07-15 at 11 55 58
  • A new Tutorials tab lists tutorials from our blog. These are programmatically retrieved based on tags from the Roboflow blog when the documentation site is built. This means the marketing team can add tags in their same publishing platform and have the post show up on the relevant Inference docs page when the documentation site is next built.
Screenshot 2025-07-15 at 11 56 08
  • Workflow Blocks documentation pages now link to tutorials, also programmatically retrieved from Ghost and manually set via tag by the marketing team.
Screenshot 2025-07-15 at 12 44 36
  • Documentation that was reference but not named as such has been moved to the Reference section.
  • Documentation for running models via the SDK has been moved to the Reference section. We should encourage users to add models as Workflow blocks rather than running via the SDK since running in Workflows gives them access to the 100+ blocks we have made.

Type of change

  • Documentation update

How has this change been tested, please provide a testcase or example of how you tested the change?

This change can be tested by running mkdocs serve and clicking around.

Any specific deployment considerations

We need to set a GHOST_API_KEY constant in our Actions secrets so the docs build can pull the latest posts from the Roboflow blog that have been marked as tutorials.

Docs

N/A

@capjamesg capjamesg marked this pull request as draft July 15, 2025 13:00
@capjamesg capjamesg self-assigned this Jul 15, 2025
@capjamesg capjamesg added the documentation Improvements or additions to documentation label Jul 15, 2025
@PawelPeczek-Roboflow
Copy link
Collaborator

I like the changes so far, @capjamesg lmk when done

@capjamesg capjamesg marked this pull request as ready for review July 18, 2025 14:09
grzegorz-roboflow and others added 4 commits August 7, 2025 16:03
Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>
Copy link
Contributor

@hansent hansent left a comment

Choose a reason for hiding this comment

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

first link on getting started page goes to non exitent page


# load a pre-trained yolov8n model
model = get_model(model_id="yolov8n-640")
Before you get started, make sure you have [installed Inference](/install/start/).
Copy link
Contributor

Choose a reason for hiding this comment

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

this link 404s

@hansent
Copy link
Contributor

hansent commented Aug 15, 2025

I pushed a commit to fix the links to the install / setup page and add the download buttons to it. I also updated the redirect on the /download page that is used from the app to go to the setup page.

I'm a bit worried we might have to go through and check all of the links though. At least there seems to be a ton of relative links that don't work. Like all the links that are just /some/route/ for the destination don't work for (they open a new tab and then some of them load some of them don't. I think we may need to link directly to md files like e.g. /some/route.md instead (at least thats what I did for the setup links. Maybe thats only an artifact of when I run it locally? Maybe we should give it a closer comb over to make sure the links all work before mergin the docs PR?

@grzegorz-roboflow
Copy link
Contributor

@capjamesg , I only noticed, can you sign your commits?

@hansent
Copy link
Contributor

hansent commented Sep 4, 2025

@capjamesg are these still desired updates? the merge conflicts are blocking I think

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants