Add a spacemacs dotfile documentation section

[syl20bnr]

No description provided.

[Olical]

Any more thought on keeping the readme documentation really minimal and placing most of it within an interface in Emacs? Maybe something that can be filtered with helm :)

I really think the readme will make a good installation and getting started guide, but documentation within Emacs will be the best route for everything else.

[syl20bnr]

@Wolfy87 I'm glad that you propose such an interface, it makes issue #4 even more relevant. The initial idea is to have a helm buffer with a list of all packages installed or available classified by layers in helm groups.

+1 for keeping the readme straight to the point.

What do you think about litterate programming in packages.el files ? We can add usefull notes we can publish and keep the code speak for itself for the rest.

[trishume]

Literate programming sounds ok to me as long as it is the type that uses comments rather than fancy org-mode files and tangle/weave. I tried out a config that was based on org-mode-babel literate config files, the extra processing step caused some problems and made the whole thing harder to understand.

Also instead of a fancy spacemacs-specific helm docs thing, couldn't we use the builtin emacs doc system (apropos is it?) and interface helm with that?

[syl20bnr]

Agree on both arguments, my only concern with literate programming is that it makes to code more heavy and hard to read, especially with org indeed.

@Wolfy87 proposed to have our own man system, and you are right to suggest apropos. This is the way to go.

[syl20bnr]

Spacemacs doc integration into apropos is tacked by #48.