chore: only have the guide as the sole source of truth for the docs #987
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
Contributor
duke-m
commented
May 10, 2025
•
duke-m
commented
- removes redundancies from the website (in favor of the guide)
- leaves the "why"
- replaces "next steps" with "installing" (linking to the guide)
- no code change (chore only)
- closes Documentation practices, the Trunk website, and the guide book #867
- replaces redundant files with redirects to the guide
- content is available in the guide - guide will be the sole source of truth
- docs will be only in the guide as a sole source of truth
- remove everything except some kind of "why trunk?" ("motivation")
- replace "next steps" with "installing", linking to the guide
- this shrinks to top menu to two items
- the zola theme injects a div with "overview", but without a h1, otherwise we just could link it directly in the menu (not important imho)
|
I know this is a cut but I think it a good start. |
- sections: build, server, watch etc. - more about proxy
|
Thanks for the effort with the "boring" stuff. My only concern is, that people might have links to those page, and they will now run into 404s? Is there a way to add a re-direct? Maybe just to same page, but at least have that? |
- for the redundant files
- 0 s by default - with some hint what's happening for whatever reason the browser is not redirecting
yes, thought about it, too, but dropped it. now there is a soft redirect using a meta refresh shortcode in zola. |
|
is something missing? |
Nope, other than me having time to merge this 😁 Thanks for the ping! |
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.