Crowd fixing documentation [2]

[JAremko]

What we still need to fix:

So how about.... We all gab some?
we are done!

Proper README.org example

---

post here a list of errors that you are going to fix

Check other people's lists

---

thx! ❤️

[CeleritasCelery]

I will fix the convention of Features to Features:

[duianto]

I started looking into fixing the bibtex layer link in the org layers readme, and discovered an issue with %2B in links.

I posted it as a separate issue:
org-mode link with %2B, becomes %252B #9484

[CeleritasCelery]

One thing I noticed while fixing documentation was an inconsistency in the Install header. about half the layers have a sub header call Layer that includes installation instruction for the layer. The other half don't (which is how it is show in the template). I think it could be useful to standardize this.

In other words, you should only have the sub-header Layer if your Install header has multiple sub-headers.
For example

* Install
** Layer
** External Tool

would be okay.
But

* Install
** Layer

would not.

Just some food for thought @JAremko

[JAremko]

I updated the links list.

[JAremko]

updated list

[benreyn]

Grabbed a few more of these in #9525

[smile13241324]

Fixed some in #9536, also noticed that the html generation for the plantuml layer seems to be broken, I have opened a separate issue for this #9537

[duianto]

@smile13241324 The here link is pointing back to this issue.
https://github.com/syl20bnr/spacemacs/issues/9476#9537
the correct issue id 9537 became a fragment identifier # for this issue.

The correct url is:
https://github.com/syl20bnr/spacemacs/issues/9537
Generating plantuml layer documentation fails #9537

[smile13241324]

@duianto thanks, fixed the link

[smile13241324]

Fixed elisp, color, ibuffer and windows-scripts layer.

[smile13241324]

Fixed parinfer, pdf-tools, yaml, csv and salt layer documentations.

[smile13241324]

Fixed the missing features block for nginx, jr, nlinum and systemd layers.

[smile13241324]

Fixed the missing features block for octave and sql layer. Also added some additional remarks to the go layer.

[smile13241324]

@JAremko I think we are through, the only layers left are the internal spacemacs layers now. I had a short look into them and most of them have just a TODO tag for adding documentation.

Should I do anything with them?

[smile13241324]

Fixed the documentation for the last two non internal spacemacs layers, spell-checking and ansible layer.

[JAremko]

I had a short look into them and most of them have just a TODO tag for adding documentation.
Should I do anything with them?

@smile13241324 Some basic explanation of what those layers are for may be useful 🤔

[smile13241324]

I have fixed the first bunch of documentations for those internal layers.

[smile13241324]

I have fixed the spacemacs-completion and spacemacs-editing-visual layers documentation.

[smile13241324]

I have fixed spacemacs-bootstrap, spacemacs-navigation, spacemacs-visual and spacemacs-org.
Only two to go :).

[smile13241324]

I have fixed the documentation for the last two layers, spacemacs-misc and spacemacs-editing.

[smile13241324]

@JAremko I think we are finally through :)

[JAremko]

@syl20bnr I think @smile13241324 deserves a medal 🥇

[syl20bnr]

@smile13241324 great job! 💜

Let's see what achievement we can give you :-)