Tracking topic for missing module README's

Development modules
, ,
#1

An adaptation of github module README tracking issue, I figure it works better as a wiki.

For instructions on how to add a README, see here.

Make sure you update this post with links to PR’s if you have one submitted already, and to mark modules as complete after the PR gets accepted.

  • :input

    • chinese (needs to be expanded upon)
    • japanese (needs to be expanded upon)
    • layout

  • :completion

    • company
    • helm
    • ido
    • ivy

  • :ui

    • deft
    • doom
    • doom-dashboard
    • doom-quit
    • emoji
    • fill-column
    • hl-todo
    • hydra
    • indent-guides
    • ligatures
    • minimap
    • modeline
    • nav-flash
    • neotree (needs to be updated to new format)
    • ophints
    • popup +defaults
    • tabs (needs to be expanded upon)
    • treemacs
    • unicode
    • vc-gutter
    • vi-tilde-fringe
    • window-select
    • workspaces
    • zen

  • :editor

    • evil
    • file-templates
    • fold
    • format
    • god
    • lispy (needs links fixed)
    • multiple-cursors (PR, closed and incomplete)
    • objed (needs to fit format)
    • parinfer (needs to fit format)
    • rotate-text
    • snippets
    • word-wrap

  • :emacs

    • dired
    • electric
    • ibuffer
    • undo
    • vc (needs to be expanded upon)

  • :term

    • eshell
    • shell
    • term
    • vterm

  • :checkers

    • syntax
    • spell
    • grammar

  • :tools

    • ansible
    • biblio
    • debugger (in the works, do not pr)
    • direnv
    • docker
    • editorconfig
    • ein
    • eval
    • gist
    • lookup
    • lsp
    • magit
    • make
    • pass
    • pdf
    • prodigy
    • rgb
    • taskrunner
    • terraform
    • tmux
    • upload

  • :os

    • macos
    • tty

  • :lang

    • agda (needs to be updated to new format)
    • beancount
    • cc
    • clojure
    • common-lisp
    • coq (needs to be updated to new format)
    • crystal
    • csharp
    • data
    • dart
    • elixir
    • elm
    • emacs-lisp
    • erlang
    • ess
    • factor
    • faust
    • fsharp
    • fstar
    • gdscript
    • go
    • haskell
    • hy
    • idris
    • json (needs to be expanded upon)
    • java
    • javascript
    • julia
    • kotlin (needs to be expanded upon)
    • latex
    • lean
    • ledger
    • lua
    • markdown
    • nim (needs to be updated to new format)
    • nix
    • ocaml
    • org
    • php
    • plantuml
    • purescript
    • python
    • qt
    • racket
    • raku (needs to be updated to new format)
    • rest
    • rst
    • ruby
    • rust
    • scala
    • scheme
    • sh
    • sml (needs to be expanded upon)
    • solidity (needs to be updated to new format)
    • swift
    • terra
    • web
    • yaml
    • zig

  • :email

    • mu4e
    • notmuch
    • wanderlust

  • :app

    • calendar
    • emms
    • everywhere
    • irc
    • rss
    • twitter

  • :config

    • literate
    • default (needs to be updated to new format)
#2

Biblio now has a README.

1 Like
#3

Yeah, the post hasn’t been updated for six months, so it’s due for one, unless this is tracked in rewrite-docs or something now.

#4

I’ve been meaning to move this tracking effort to this project on our Github org once I’ve moved hlissner/doom-emacs to it—then more people will have write access to its projects. I’ll update biblio’s entry there soon.

2 Likes
#5

Since it’s a todo thing it probably fits better as a Github project, but the post is a wiki, so anyone can edit it.

On the rewrite-docs branch everything already has some sort of readme, so the tracking needs to switch to completeness level, which the tracking on the Github project already has

#6

Oh, I didn’t realize discourse had wiki capabilities!