Skip to content

Document the new in-repo examples directory#3062

Merged
markphelps merged 3 commits into
mainfrom
copilot/update-readme-examples-folder
Jun 16, 2026
Merged

Document the new in-repo examples directory#3062
markphelps merged 3 commits into
mainfrom
copilot/update-readme-examples-folder

Conversation

Copilot AI commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

Cog’s example models now live in replicate/cog under examples/, but the README and public docs still pointed at the old standalone examples repository. This updates the docs surface area to treat the in-repo examples tree as the canonical entry point.

  • README + docs entry points

    • Replaced the old replicate/cog-examples link in the root README with the new in-repo examples docs page.
    • Added examples references to the getting started and deployment docs so example projects are discoverable from common entry paths.
  • New public examples page

    • Added docs/examples.md and wired it into mkdocs.yml.
    • Summarizes the main examples by use case: minimal runners, image models, training, streaming, context, secrets, notebooks, and managed weights.
  • Examples index in the repo

    • Added examples/README.md as a root index for the examples tree.
    • Includes short, scan-friendly descriptions for each example, plus the experimental managed-weights example.
  • Generated docs sync

    • Regenerated docs/llms.txt so the bundled public docs reflect the new examples location and links.

Example of the updated docs entry point:

- [Browse the example models in this repo](docs/examples.md)

@markphelps markphelps marked this pull request as ready for review June 16, 2026 19:21
@markphelps markphelps requested a review from a team as a code owner June 16, 2026 19:21
@markphelps markphelps merged commit b43bd96 into main Jun 16, 2026
42 of 43 checks passed
@markphelps markphelps deleted the copilot/update-readme-examples-folder branch June 16, 2026 19:55
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.

3 participants