docs: repoint Getting Started examples to per-repo URLs#25
Open
Terastar-Paperclip wants to merge 1 commit into
Open
docs: repoint Getting Started examples to per-repo URLs#25Terastar-Paperclip wants to merge 1 commit into
Terastar-Paperclip wants to merge 1 commit into
Conversation
The three worked examples now live in each CLI's repo (docs/example.md): - quantcli/crono-export-cli#47 (merged) - quantcli/liftoff-export-cli#49 (merged) - quantcli/withings-export-cli#40 (merged) Drop the in-tree docs/example-{crono,liftoff,withings}.md copies and point GETTING_STARTED.md "Going further" at the canonical per-repo URLs. Keeps the source of truth next to the code it documents. Co-Authored-By: Paperclip <noreply@paperclip.ing>
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
3 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
The three worked examples are now hosted in each CLI's own repo:
This PR removes the in-tree copies under
docs/example-*.mdand pointsGETTING_STARTED.md"Going further" at the canonical per-repo URLs.Why
Source of truth lives next to the code each example documents. A reader who lands on
crono-export-clifinds the worked example there; the standards repo links out rather than mirroring (which would drift).Sequenced after the three per-repo PRs merged so the new links resolve at push time — verified by clicking through each before publishing.
Test plan
grep -rn "docs/example-" .returns no stragglers in this repodocs/example.mdURLs resolve on GitHubGETTING_STARTED.mdrenders cleanly (heading hierarchy unchanged, only link target swap)Closes the cleanup half of QUA-45.