From 9bd32d097bcf56319b47e848530f9db21a4ee7f8 Mon Sep 17 00:00:00 2001 From: Roshan Sharma Date: Thu, 27 Aug 2026 13:52:53 -0400 Subject: [PATCH] docs: give the Quickstart and Changelog nav entries real pages Both entries in mkdocs.yml pointed at files that do not exist under docs/, so the published sidebar linked to two 404s. Rather than duplicate content, both pages now single-source from files that already exist. quickstart.md pulls the README's Quickstart section through pymdownx.snippets, and changelog.md includes the root CHANGELOG.md, so neither can drift from the canonical copy. --- README.md | 3 +++ docs/changelog.md | 1 + docs/quickstart.md | 1 + mkdocs.yml | 3 +++ 4 files changed, 8 insertions(+) create mode 100644 docs/changelog.md create mode 100644 docs/quickstart.md diff --git a/README.md b/README.md index 63b78ead..45368458 100644 --- a/README.md +++ b/README.md @@ -111,6 +111,7 @@ rf = roboflow.Roboflow(api_key="") + ## Quickstart Below are some common methods used with the Roboflow Python package, presented concisely for reference. For a full library reference, refer to the [Roboflow API reference documentation](https://docs.roboflow.com/api-reference). @@ -155,6 +156,8 @@ predictions = model.predict(img_url, hosted=True).json() print(predictions) ``` + + ### Search and Export Search for images across your workspace and export matching results as a ready-to-use dataset: diff --git a/docs/changelog.md b/docs/changelog.md new file mode 100644 index 00000000..786b75d5 --- /dev/null +++ b/docs/changelog.md @@ -0,0 +1 @@ +--8<-- "CHANGELOG.md" diff --git a/docs/quickstart.md b/docs/quickstart.md new file mode 100644 index 00000000..98f76249 --- /dev/null +++ b/docs/quickstart.md @@ -0,0 +1 @@ +--8<-- "README.md:quickstart" diff --git a/mkdocs.yml b/mkdocs.yml index 11543b97..a6ccb49a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -58,6 +58,9 @@ markdown_extensions: - admonition - pymdownx.details - pymdownx.superfences + - pymdownx.snippets: + base_path: ['.'] + check_paths: true - attr_list - md_in_html - pymdownx.tabbed: