docs(:checkers): update READMEs to new format

2021-10-16 01:21:10 +02:00 · 2021-10-16 01:21:10 +02:00 · b898fbe303
commit b898fbe303
parent 5b354ae4f3
4 changed files with 248 additions and 199 deletions
--- a/modules/checkers/syntax/README.org
+++ b/modules/checkers/syntax/README.org
@ -1,66 +1,85 @@
-#+TITLE:   checkers/syntax
-#+DATE:    February 20, 2017
-#+SINCE:   v2.0
-#+STARTUP: inlineimages nofold
+← [[doom-module-index:][Back to module index]]               ↙ [[doom-module-issues:::checkers syntax][Issues]]  ↖ [[doom-module-source:checkers/syntax][Source]]  ± [[doom-suggest-edit:][Suggest edits]]  ? [[doom-help-modules:][Help]]
+--------------------------------------------------------------------------------
+#+TITLE:    :checkers syntax
+#+SUBTITLE: Tasing you for every semicolon you forget
+#+CREATED:  May 29, 2021
+#+SINCE:    2.0.0

-* Table of Contents :TOC_3:noexport:
- [[#description][Description]]
-  - [[#maintainers][Maintainers]]
-  - [[#module-flags][Module Flags]]
-  - [[#plugins][Plugins]]
-  - [[#hacks][Hacks]]
- [[#prerequisites][Prerequisites]]
- [[#features][Features]]
- [[#configuration][Configuration]]
- [[#troubleshooting][Troubleshooting]]
-
-* Description
-This module provides syntax checking and error highlighting, powered by [[https://github.com/flycheck/flycheck][flycheck]]
-
-+ If possible, include a brief list of feature highlights here
-+ Like code completion, syntax checking or available snippets
-+ Include links to packages & external things where possible
+* Description :unfold:
+This module provides syntax checking and error highlighting, powered by
+[[doom-package:][flycheck]].

 ** Maintainers
-This module has no dedicated maintainers.
+/This module has no dedicated maintainers./ [[doom-contrib-maintainer:][Become a maintainer?]]

-** Module Flags
-+ =+childframe= Enables displaying completion candidates in a child frame, rather than an overlay or tooltip (among with other UI enhancements).
+** Module flags
+- +childframe ::
+  Display errors/warnings in a [[https://www.gnu.org/software/emacs/manual/html_node/elisp/Child-Frames.html][child frame]] rather than an overlay or tooltip.
+  *Requires GUI Emacs.*

-
-** Plugins
-+ [[https://github.com/flycheck/flycheck][flycheck]]
-+ [[https://github.com/flycheck/flycheck-popup-tip][flycheck-popup-tip]]
-+ =+childframe=
-  + [[https://github.com/alexmurray/flycheck-posframe][flycheck-posframe]]
+** Packages
+- [[doom-package:][flycheck]]
+- [[doom-package:][flycheck-popup-tip]]
+- [[doom-package:][flycheck-posframe]] if [[doom-module:][+childframe]]

 ** Hacks
-If =lsp-ui-mode= is active, most of the aesthetic functionality of this module is turned off, as they show the same information.
+- If ~lsp-ui-mode~ is active, most of the aesthetic functionality of this module
+  is turned off, as they show the same information.

-* Prerequisites
-This module has no direct prerequisites.
+** TODO Changelog
+# This section will be machine generated. Don't edit it by hand.
+/This module does not have a changelog yet./

-However, some major modes may require a specific linter or program to work, and some major modes may not work at all. The best way to find these dependencies is by either reading the documentation for that module, or running =doom doctor=.
+* Installation
+[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]
+
+This module has no direct requirements, but some languages may have their own
+requirements to fulfill before you get syntax checking in them (and some
+languages may lack syntax checking support altogether). Run ~$ doom doctor~ to
+find out if you're missing any dependencies.
+
+* TODO Usage
+#+begin_quote
+ 🔨 /This module's usage documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
+#+end_quote
+
+Most of flycheck's features are under [[kbd:][C-c !]], regardless of whether evil mode is
+used.

-* Features
-Most of flycheck's features are under =C-c !=, regardless of whether evil mode is used.
 | Keybind | Description                 |
-| C-c ! ? | Describe Checker ]          |
-| C-c ! c | Check syntax in buffer      |
-| C-c ! l | List errors                 |
-| C-c ! n | Next Error                  |
-| C-c ! p | Previous error              |
-| C-c ! C | Clear all errors in buffer  |
-| C-c ! e | Explain error at point      |
-| C-c ! h | Display all errors at point |
+|---------+-----------------------------|
+| [[kbd:][C-c ! ?]] | Describe Checker            |
+| [[kbd:][C-c ! c]] | Check syntax in buffer      |
+| [[kbd:][C-c ! l]] | List errors                 |
+| [[kbd:][C-c ! n]] | Next Error                  |
+| [[kbd:][C-c ! p]] | Previous error              |
+| [[kbd:][C-c ! C]] | Clear all errors in buffer  |
+| [[kbd:][C-c ! e]] | Explain error at point      |
+| [[kbd:][C-c ! h]] | Display all errors at point |

-Evil Specific
+Evil Specific:
 | Keybind | Description     |
-| SPC t f | Toggle Flycheck |
-| SPC c x | List errors     |
-| ] e     | Next error      |
-| [ e     | Prevous error   |
+|---------+-----------------|
+| [[kbd:][SPC t f]] | Toggle Flycheck |
+| [[kbd:][SPC c x]] | List errors     |
+| [[kbd:][] e]]     | Next error      |
+| [[kbd:][[ e]]     | Prevous error   |

 * TODO Configuration
+#+begin_quote
+ 🔨 This module has no configuration documentation yet. [[doom-contrib-module:][Write some?]]
+#+end_quote

-* TODO Troubleshooting
+* Troubleshooting
+[[doom-report:][Report an issue?]]
+
+- Use ~M-x flycheck-verify-setup~ to determine what checkers are available in a
+  buffer and whether they're active or not (and why).
+
+* Frequently asked questions
+/This module has no FAQs yet./ [[doom-suggest-faq:][Ask one?]]
+
+* TODO Appendix
+#+begin_quote
+ 🔨 This module has no appendix yet. [[doom-contrib-module:][Write one?]]
+#+end_quote