docs: update links in documentation and modules index #8404
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
some links were missing, outdated, or without description tried to remedy that a bit, pulling some information from behind the links to the overview also small insertion for private config bisecting, some sembr lines (better reading flow in editor) and headline capitalisation improvements index.org duplicates a lot of info from the README and tends to lag behind, should consider options of merging - from what I know github could support a README.org that could also serve as index then, or vice versa linking the markdown readme in emacs
hlissner
added
is:docs
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.
some links were missing, outdated, or without description
tried to remedy that a bit,
pulling some information from behind the links to the overview
also small insertion for private config bisecting, some sembr lines (better reading flow in editor)
and headline capitalisation improvements
index.org duplicates a lot of info from the README and tends to lag behind, should consider options of merging - from what I know github could support a README.org that could also serve as index then,
or vice versa linking the markdown readme in emacs
sorry seems I violated Do not PR (DNP) but as I was reviewing my now year-old config, having that incompleteness was a bit off-putting and I only saw that on the list now.
the donotpr list link on https://github.com/doomemacs/doomemacs/blob/master/docs/contributing.org#commits--prs is also out of date and a bit hidden away, I think this should be higher up so you see it before starting your work, not at the time you did something and are opening a PR