docs(readme): link to docs/examples#93
Merged
Merged
Conversation
leoparente
requested review from
MicahParks,
jajeffries,
ltucker,
marc-barry and
mfiedorowicz
as code owners
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
Coverage Report
|
||||||||||||||||||||||||||||||||||||||||
leoparente
force-pushed
the
fix/readme-examples-link
branch
from
35f396f to
3724e24
Compare
The README previously had a `[examples](./examples)` link that pointed to a non-existent directory (#74); the broken link was removed during the v1.10.x README restructure, but no replacement pointer was added. Since #83 there is a real `docs/examples/` directory with one file per supported entity. Add a one-line pointer in the same anchor location the original broken link occupied so readers can find them from the README again. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
leoparente
force-pushed
the
fix/readme-examples-link
branch
from
3724e24 to
03f75bb
Compare
leoparente
changed the title
MicahParks
approved these changes
Jun 1, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Closes the second half of #74.
The original report (Dec 2025) flagged a broken
[examples](./examples)link in the README pointing at a non-existent directory. The broken link itself was removed during the v1.10.x README restructure (#78), and #83 later added a realdocs/examples/directory — but the README was never updated to point at it, so readers still have no in-README path to the example catalog.This adds a one-line pointer at the exact anchor location the original broken link occupied (right after the basic Example code block).
Change
if __name__ == "__main__": main()+See
docs/examples/for per-entity examples (one file per supported NetBox object type).+
Using Metadata