Documentation and Developer Experience Overhaul

We’ve made major improvements to our documentation and developer experience to help you find resources faster and better understand how to use Roboflow’s tools:

Enhanced Documentation and New Resources

  • Updated Inference README: Now highlights core value propositions and workflows for easier reference.

  • New Code Snippets: Examples now feature workflows to showcase best practices.

  • API Key Usage Explained: Clearer guidelines on when an API key is required.

  • Hosted Compute Offerings: Added detailed descriptions of available compute services.

  • Expanded Installation Guides: Platform-specific setup instructions for a smoother onboarding experience.

  • Licensing Clarifications: Simplified and clarified terms.

New Public Workflows

  • Explore cloud-hosted workflows without needing an API key. Public workflows let developers try out examples before creating a Roboflow account.

Improved Documentation Infrastructure

  • New Landing Page: A better-organized starting point with dedicated sections for Models, Workflows, Reference, and Cookbooks.

  • Streamlined Navigation:

    • Fixed top-level navigation for easier browsing, especially on mobile.

    • Reorganized pages to prioritize installation instructions and logical content flow.

    • Updated side navigation to ensure every page is connected and easy to access.

Expanded Reference Docs

  • Added new reference guides for SDK and CLI to complement existing inference pip package documentation.

Performance and Usability Enhancements

  • Faster Navigation: Instant client-side browsing with pre-loaded links for a snappier experience.

  • Hover Previews: Wikipedia-style previews on internal links for better context before clicking.

  • Improved Search: More relevant search results with better filtering.

  • Updated Design: Refreshed icons, fonts, and colors for a more polished look.

These changes make it easier than ever to explore our documentation, improve workflow comprehension, and navigate resources efficiently.

Last updated

Was this helpful?