Improve links to Step by step #10654
Merged
Conversation
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
tetrapod00
added
enhancement
area:about
tetrapod00
commented
Feb 9, 2025
tetrapod00
commented
Feb 9, 2025
|
|
||
| This step-by-step tutorial is intended for beginners who followed the complete | ||
| :ref:`Getting Started <toc-learn-step_by_step>`. | ||
| :ref:`doc_step_by_step`. |
There was a problem hiding this comment.
Used this shortform syntax because the title of the section below the reference label is acceptable, and will automatically update if we change it in the future.
skyace65
requested changes
Feb 9, 2025
tetrapod00
force-pushed
the
step-step-link
branch
from
7c67634 to
9ffbae7
Compare
skyace65
approved these changes
Feb 9, 2025
|
Thanks! |
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.
This started with the mismatched title and link:
But we don't really link to TOCs as best practice anymore, instead we use Sphinx labels (anchors). So I made one of those, then changed all the references to the TOC to use the anchor instead. And I noticed that
About/Introductiontells new readers to skip part ofGetting Started(the original commit is ancient and the context has changed), so I fixed that too.