split dev env docs into 2 documents for easier navigation#439
Merged
Conversation
xrstf
force-pushed
the
improve-dev-docs
branch
from
1785a0d to
46be9e4
Compare
cnvergence
requested changes
Jan 20, 2026
mjudeikis
previously approved these changes
Jan 21, 2026
Contributor
Author
|
Let me touch the docs a bit more, the note on one of the pages is misleading. |
On-behalf-of: @SAP christoph.mewes@sap.com
xrstf
force-pushed
the
improve-dev-docs
branch
from
46be9e4 to
f7dc9c1
Compare
mjudeikis
previously approved these changes
Jan 21, 2026
Contributor
Author
|
@cnvergence fixed the links, thanks for noticing. I would have applied strict mode to our docs, but we have a broken link to a "Template Reference" and I did not want to just create a dummy page for that. |
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
While clever, I found the current solution to providing the dev env setup docs to be cumbersome to use. They are IMHO simply too long to use the tabbed UI in the docs effectively.
So I split the guide into standalone pages:
What Type of PR Is This?
/kind documentation
Release Notes