Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign upMissing/incomplete module documentation #1166
Comments
|
Thanks for this! Although, please use either completion/company/README.org or the readme file template as the template. I'm open to improvements, but that is the format I'm aiming for. |
|
Ah ok! I can use that template to write some module documentations what I use mostly. |
|
@Amatrelan what would be the best way to keep this list up to date? As of now ui:worspaces, ui:doom, ui:doom-dashboard, and app:write have been updated. |
|
Imo the best way is to add EDIT: The issue now would be to create a difference with incomplete modules, a different tag (e.g. |
|
This could be misleading for new-comers though, since they might see the TODO and FIXME tags as indications that the modules themselves are not complete instead of their documentation. |
|
Well you can always add a small note at the beggining of the doc. There migth be other more pressing issues with this method. |
|
Hi, can I help writing some docs. Have you some style guide or help to write the docs? Do you have any recommendations on where to start? |
|
I recently started doing exactly the same. I started based on this comment #1166 (comment) |
I try to keep up here to update it, but I think currently only @hlissner and me are only ones that can modify original issue. I added to original issue description how to get yas snippet template to use as barebone for readme files. |
|
@Amatrelan if you create a Readme file in a module directory that is missing one and snippets are enabled it automatically inserts the snippet. Additionally, can you please add the following command as an example for figuring out the |
Co-authored-by: Henrik Lissner <henrik@lissner.net>
Co-authored-by: Henrik Lissner <henrik@lissner.net>
I added all the things I know about this module but there might be something I don't know about so check and validate. This is related to hlissner#1166 effort.
I added all the things I know about this module but there might be something I don't know about so check and validate. This is related to hlissner#1166 effort.
|
There seems to be some module structure changes and some were moved to other places so I tried to make more accurate issue. But there seems to be some modules removed so can you @hlissner check those. I didn't remove them but put (removed?) on them so easier to find. And I will check out all so I can see if there is some README.orgs put in modules but forgot to update this issue now too. |
I added all the things I know about this module but there might be something I don't know about so check and validate. This is related to hlissner#1166 effort.
|
I probably should have referenced this issue in the PR itself, but #3060 added a README for tools/rgb |
I created this meta issue to track missing documentation. I added [x] even
thought documentation might not be complete. This point is just to make easier
to people to find what module needs documentation, so they can easier contribute
to documentation.
If you want to contribute to documentation there is snippet template,
M-x -> yas-snippet-insert ->Doom module readme
Or in org-mode you can also write
__doom-readme<TAB>to open readme snippet.To get SINCE tag use @zakkak suggestion
git describe --tags $(git log --format="%H" -- $HOME/.emacs.d/modules/lang/ledger | tail -1) | cut -d - -f 1All these are from develop branch.