Commit graph

10 commits

Author SHA1 Message Date
Fabien Dubosson 315528c89f Refactor CONTRIBUTING documentations
This commit merge the `CONTRIBUTING.md` and `doc/CONTRIBUTE.org` file
into a new `CONTRIBUTING.org` file. It also refactors the content to be
more organized and make its navigation more goal-oriented.

Github displays a link to the `CONTRIBUTING.*` file when people are
opening new issues or proposing new PRs. This file is important because
it is the entry-point to contributions guidelines for most of the users.
The current setup is non-optimal, even broken, as it adds a level of
indirection, and points to a contributing file that has broken
links (due to the new documentation format). The possible drawback of
the proposed solution is that I'm not sure if it is possible to include
it into the new online documentation as it is not in `doc/` folder.

The other possibility is to keep a small `CONTRIBUTING.md` file, as it
is now, pointing to the new documentation system (once online), but I'm
preferring the proposed solution for the following reasons:

- People that are willing to contribute will probably open Github
  first (for forking, creating PR, etc), not the online documentation.

- It has one level of indirection less when people click on the
  guidelines guide from a new issue/PR.

- `CONTRIBUTING.*` is by convention a special kind of file on github, so
  it's valid reason to break the rule and not having it in the `doc/`
  folder.
2015-12-11 01:09:09 -05:00
Eivind Fonn 88c019d4d6 Fix helm-spacemacs package action 2015-11-12 10:49:31 +01:00
Eivind Fonn a991927288 Beautify helm-spacemacs 2015-11-11 23:01:54 +01:00
Eivind Fonn fa975c4c45 Fix helm-spacemacs with new FAQ.org format 2015-11-02 15:05:39 +01:00
Fabien Dubosson 8d3c59c78f Discard buffer from marker, switch to it when asked 2015-10-09 12:11:24 +02:00
Fabien Dubosson 6442e00b2e Use a temp buffer to read the FAQ in helm-spacemacs
Correct a bug in helm-spacemacs: Whenever a function was needing the
FAQ's candidates in helm-spacemancs (`SPC f e h` and `SPC f e f`), the
`FAQ.org` file was open in a buffer and not closed. This commit corrects
this by loading the content of `FAQ.org` in a temp buffer and switch it
to `org-mode` in order to get the candidates.
2015-10-09 12:11:24 +02:00
Fabien Dubosson 5e3dbd9234 Add FAQ as a source in helm-spacemacs
Add the `FAQ.org` file as a source in helm-spacemacs (`SPC f e h`).
Define a new keybinding for looking directly inside the FAQ with helm:
`SPC f e f`.

With help from TheBB, thanks!
2015-10-07 15:51:38 -04:00
Eivind Fonn 273d6b5d11 helm-spacemacs: action to open readme for editing 2015-10-05 12:16:46 +02:00
person808 a7c4014c3f Add new descriptions for new files in helm-spacemacs. 2015-09-24 00:36:53 -04:00
Robert O'Connor 3f2e885811 Rename spacemacs-core to spacemacs-base
Per the discussion in #3002. A comment in #3047 prompted this PR.
2015-09-16 21:22:35 -04:00