Skip to content

Missing/incomplete module documentation #1166

@amatrelan

Description

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    good first issueA good target for beginner contributorshelp wantedCannot be resolved without outside helpis:docsPertains to the project's manual, output of help commands, or API documentationis:featureAdds or requests new features, or extends existing onesstatus:confirmedIssue was verified, or request approved. Waiting for a working solution.

    Type

    No type

    Projects

    Status

    Ready

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions