Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Crowd fixing documentation [2] #9476

Closed
JAremko opened this issue Aug 22, 2017 · 49 comments

Comments

@JAremko
Copy link
Collaborator

commented Aug 22, 2017

What we still need to fix:

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

Proper README.org example


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

Check other people's lists


thx! ❤️

@CeleritasCelery

This comment has been minimized.

Copy link

commented Aug 23, 2017

I will fix the convention of Features to Features:

@duianto

This comment has been minimized.

Copy link
Collaborator

commented Aug 24, 2017

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

This comment has been minimized.

Copy link

commented Aug 28, 2017

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

This comment has been minimized.

Copy link
Collaborator Author

commented Aug 29, 2017

I updated the links list.

@JAremko

This comment has been minimized.

Copy link
Collaborator Author

commented Aug 30, 2017

updated list

@benreyn

This comment has been minimized.

Copy link

commented Sep 1, 2017

Grabbed a few more of these in #9525

@smile13241324

This comment has been minimized.

Copy link
Collaborator

commented Sep 3, 2017

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

JAremko added a commit that referenced this issue Sep 11, 2017
@duianto

This comment has been minimized.

Copy link
Collaborator

commented Sep 11, 2017

@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

This comment has been minimized.

Copy link
Collaborator

commented Sep 12, 2017

@duianto thanks, fixed the link

@smile13241324

This comment has been minimized.

Copy link
Collaborator

commented Oct 1, 2017

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

benreyn added a commit to benreyn/spacemacs that referenced this issue Oct 4, 2017
Fix various documentation errors and inconsistencies
Fixes documentation errors from issue syl20bnr#9476 in the following layers...
* syntax-checking
* games
* xkcd
* keyboard-layout
* racket
benreyn added a commit to benreyn/spacemacs that referenced this issue Oct 4, 2017
Fix various documentation errors and inconsistencies
Fixes documentation errors from issue syl20bnr#9476 in the following layers...
* syntax-checking
* games
* xkcd
* keyboard-layout
* racket
* osx
@smile13241324

This comment has been minimized.

Copy link
Collaborator

commented Oct 4, 2017

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

@smile13241324

This comment has been minimized.

Copy link
Collaborator

commented Feb 5, 2018

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

@smile13241324

This comment has been minimized.

Copy link
Collaborator

commented Feb 16, 2018

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

@smile13241324

This comment has been minimized.

Copy link
Collaborator

commented Feb 16, 2018

@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

This comment has been minimized.

Copy link
Collaborator

commented Feb 16, 2018

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

@JAremko

This comment has been minimized.

Copy link
Collaborator Author

commented Feb 16, 2018

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

This comment has been minimized.

Copy link
Collaborator

commented Feb 18, 2018

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

@smile13241324

This comment has been minimized.

Copy link
Collaborator

commented Feb 20, 2018

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

@smile13241324

This comment has been minimized.

Copy link
Collaborator

commented Feb 26, 2018

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

@smile13241324

This comment has been minimized.

Copy link
Collaborator

commented Feb 26, 2018

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

@smile13241324

This comment has been minimized.

Copy link
Collaborator

commented Feb 26, 2018

@JAremko I think we are finally through :)

@JAremko

This comment has been minimized.

Copy link
Collaborator Author

commented Feb 27, 2018

@syl20bnr I think @smile13241324 deserves a medal 🥇

@syl20bnr

This comment has been minimized.

Copy link
Owner

commented Feb 28, 2018

@smile13241324 great job! 💜

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

buckarooch added a commit to profilech/.emacs.d that referenced this issue May 19, 2018
typography: add “Features:” section
Add a “Features:” section by taking relevant pieces from the
“Description” supersection.

See: syl20bnr#9476
buckarooch added a commit to profilech/.emacs.d that referenced this issue May 19, 2018
buckarooch added a commit to profilech/.emacs.d that referenced this issue May 19, 2018
mu4e: add “Features:” section
This is based on the description on [mu4e’s homepage], accessed
2017-11-03.

[mu4e’s homepage]: <http://www.djcbsoftware.nl/code/mu/mu4e.html>

See: syl20bnr#9476
buckarooch added a commit to profilech/.emacs.d that referenced this issue May 19, 2018
theming: add “Features:” section
Add “Features:” section with bullet points based on reading the rest of
the readme.

See: syl20bnr#9476

@JAremko JAremko closed this May 24, 2018

CodingSolo pushed a commit to CodingSolo/spacemacs that referenced this issue Oct 29, 2018
CodingSolo pushed a commit to CodingSolo/spacemacs that referenced this issue Oct 29, 2018
Fix various documentation errors and inconsistencies
Fixes documentation errors from issue syl20bnr#9476 in the following layers...

* syntax-checking
* games
* xkcd
* keyboard-layout
* racket
* osx
CodingSolo pushed a commit to CodingSolo/spacemacs that referenced this issue Oct 29, 2018
typography: add “Features:” section
Add a “Features:” section by taking relevant pieces from the
“Description” supersection.

See: syl20bnr#9476
CodingSolo pushed a commit to CodingSolo/spacemacs that referenced this issue Oct 29, 2018
CodingSolo pushed a commit to CodingSolo/spacemacs that referenced this issue Oct 29, 2018
mu4e: add “Features:” section
This is based on the description on [mu4e’s homepage], accessed
2017-11-03.

[mu4e’s homepage]: <http://www.djcbsoftware.nl/code/mu/mu4e.html>

See: syl20bnr#9476
CodingSolo pushed a commit to CodingSolo/spacemacs that referenced this issue Oct 29, 2018
theming: add “Features:” section
Add “Features:” section with bullet points based on reading the rest of
the readme.

See: syl20bnr#9476
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
8 participants
You can’t perform that action at this time.