Doom-emacs: Missing/incomplete module documentation

[Amatrelan]

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 1

All these are from develop branch.

• [ ] input
  
  
  
  • [X] chinese (incomplete)
  
  
  • [X] japanese (incomplete)
  
  
• [ ] completion
  
  
  
  • [X] Company
  
  
  • [ ] helm
  
  
  • [ ] ido
  
  
  • [X] ivy
  
  
• [ ] ui
  
  
  
  • [ ] deft (incomplete, update to new format)
  
  
  • [X] doom
  
  
  • [X] doom-dashboard
  
  
  • [X] doom-quit (incomplete, update to new format)
  
  
  • [ ] fill-column
  
  
  • [X] hl-todo (incomplete, update to new format)
  
  
  • [X] hydra
  
  
  • [ ] indent-guides
  
  
  • [X] modeline (incomplete, there is a lot of TODO)
  
  
  • [X] nav-flash
  
  
  • [X] neotree (incomplete, update to new format)
  
  
  • [X] ophints (incomplete)
  
  
  • [X] popup
  
  
  • [x] pretty-code
  
  
  • [X] tabs (incomplete)
  
  
  • [ ] treemacs
  
  
  • [X] unicode (incomplete, update to new format)
  
  
  • [ ] vc-gutter
  
  
  • [ ] vi-tilde-fringe
  
  
  • [X] window-select
  
  
  • [X] workspaces
  
  
  • [X] zen
  
  
• [ ] editor
  
  
  
  • [ ] evil (keybindings need update)
  
  
  • [X] file-templates
  
  
  • [X] fold (incomplete)
  
  
  • [ ] format
  
  
  • [ ] god
  
  
  • [X] lispy
  
  
  • [ ] multiple-cursors
  
  
  • [X] objed (incomplete)
  
  
  • [X] parifier (incomplete)
  
  
  • [ ] rotate-text
  
  
  • [X] snippets (incomplete)
  
  
  • [X] word-wrap
  
  
• [ ] emacs
  
  
  
  • [X] dired
  
  
  • [ ] electric
  
  
  • [X] ibuffer (incomplete)
  
  
  • [X] undo (incomplete)
  
  
  • [ ] vc
  
  
• [ ] term
  
  
  
  • [ ] eshell
  
  
  • [ ] shell
  
  
  • [ ] term
  
  
  • [x] vterm
  
  
• [ ] checkers
  
  
  
  • [ ] syntax
  
  
  • [ ] spell
  
  
  • [X] grammar
  
  
• [ ] tools
  
  
  
  • [ ] ansible
  
  
  • [ ] debugger
  
  
  • [x] direnv
  
  
  • [x] docker
  
  
  • [X] editorconfig (incomplete, update to new format)
  
  
  • [X] ein
  
  
  • [X] eval
  
  
  • [ ] gist
  
  
  • [X] lookup
  
  
  • [X] lsp (incomplete)
  
  
  • [ ] macos
  
  
  • [ ] magit (incomplete)
  
  
  • [ ] make
  
  
  • [ ] pass
  
  
  • [ ] pdf
  
  
  • [ ] prodigy
  
  
  • [ ] rgb
  
  
  • [x] terraform
  
  
  • [ ] tmux
  
  
  • [x] upload
  
  
  • [X] wakatime (removed?)
  
  
• [ ] lang
  
  
  
  • [X] agda (incomplete, update to new format)
  
  
  • [ ] assembly (removed?)
  
  
  • [X] cc
  
  
  • [X] clojure (incomplete)
  
  
  • [ ] common-lisp
  
  
  • [X] coq (incomplete, update to new format)
  
  
  • [ ] crystal
  
  
  • [X] csharp (incomplete, update to new format)
  
  
  • [ ] data
  
  
  • [X] dart
  
  
  • [x] elixir
  
  
  • [ ] elm
  
  
  • [ ] emacs-lisp
  
  
  • [X] erlang
  
  
  • [X] ess (incomplete, update to new format)
  
  
  • [X] faust
  
  
  • [X] fsharp
  
  
  • [X] fstar
  
  
  • [X] go
  
  
  • [X] haskell
  
  
  • [ ] hy
  
  
  • [X] idris (incomplete, update to new format)
  
  
  • [X] json (incomplete)
  
  
  • [X] java
  
  
  • [X] javascript
  
  
  • [x] julia
  
  
  • [X] kotlin (incomplete)
  
  
  • [X] latex (incomplete)
  
  
  • [ ] lean
  
  
  • [X] factor
  
  
  • [x] ledger
  
  
  • [ ] lua
  
  
  • [X] markdown
  
  
  • [X] nim
  
  
  • [ ] nix
  
  
  • [X] ocaml
  
  
  • [X] org (incomplete)
  
  
  • [X] perl (incomplete, update to new format)
  
  
  • [X] php
  
  
  • [ ] plantuml
  
  
  • [ ] purescript
  
  
  • [x] python
  
  
  • [ ] qt
  
  
  • [X] racket (incomplete)
  
  
  • [X] rest
  
  
  • [ ] rst
  
  
  • [X] ruby
  
  
  • [X] rust
  
  
  • [ ] scala
  
  
  • [X] sheme
  
  
  • [X] sh
  
  
  • [x] sml (incomplete)
  
  
  • [X] solidify (incomplete, update to new format)
  
  
  • [ ] swift
  
  
  • [ ] terra
  
  
  • [ ] vala (removed?)
  
  
  • [ ] web
  
  
  • [X] yaml (incomplete)
  
  
• [ ] email
  
  
  
  • [X] mu4e
  
  
  • [x] notmuch
  
  
  • [ ] wanderlust
  
  
• [ ] app
  
  
  
  • [X] calendar
  
  
  • [X] irc
  
  
  • [x] rss
  
  
  • [x] twitter
  
  
  • [X] write (removed?)
  
  
• [ ] config
  
  
  
  • [ ] literate
  
  
  • [X] default (incomplete, update to new format)
  
  

[hlissner]

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.

[Amatrelan]

Ah ok! I can use that template to write some module documentations what I use mostly.

[zakkak]

@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.

[A6GibKm]

Imo the best way is to add TODOto the headers in https://github.com/hlissner/doom-emacs/blob/develop/modules/README.org and require for that to be updated before any merge.

EDIT: The issue now would be to create a difference with incomplete modules, a different tag (e.g. FIX) could be used.

[zakkak]

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.

[A6GibKm]

Well you can always add a small note at the beggining of the doc. There migth be other more pressing issues with this method.

[kcurtet]

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?

[zakkak]

I recently started doing exactly the same. I started based on this comment https://github.com/hlissner/doom-emacs/issues/1166#issuecomment-462459077
Regarding where to start I guess wherever you feel more comfortable, for instance I started with some refactoring of existing documentation, marked as "update to new format" in the first comment of this issue.
You can also check my recent PRs although the above comment should be enough to get you started.

[Amatrelan]

@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.

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. M-x yas-insert-snippet Doom module readme or just __doom-readme <TAB> Both of those requires snippets module enabled.

[zakkak]

@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 #+SINCE tag?

git describe --tags $(git log --format="%H" -- $HOME/.emacs.d/modules/lang/ledger | tail -1) | cut -d - -f 1

[Amatrelan]

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.

[iyefrat]

I probably should have referenced this issue in the PR itself, but #3060 added a README for tools/rgb