Skip to content

Conversation

@xeruf
Copy link

@xeruf xeruf commented May 28, 2025

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

  • I searched the issue tracker and this hasn't been PRed before.
  • My changes are not on the do-not-PR list for this project.
  • My commits conform to Doom's git conventions.
  • Any relevant issues or PRs have been linked to.

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

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
@xeruf xeruf requested a review from a team as a code owner May 28, 2025 10:58
@hlissner hlissner added is:docs Pertains to the project's manual, output of help commands, or API documentation was:moved Is, was, or will be addressed elsewhere do not pr Not accepting PRs like this (check our do-not-PR list) labels May 28, 2025
@hlissner hlissner marked this pull request as draft May 28, 2025 11:29
@hlissner hlissner added this to the core v3.0 milestone May 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

do not pr Not accepting PRs like this (check our do-not-PR list) is:docs Pertains to the project's manual, output of help commands, or API documentation was:moved Is, was, or will be addressed elsewhere

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants