Commit graph

13 commits

Author SHA1 Message Date
JAremko
30a7b59aa6 Elaborate on README.org tags 2019-05-20 15:25:00 +03:00
JAremko
23842fa77e Simplify descriptions of layers 2019-04-21 22:09:34 +03:00
JAremko
216ebd32b9 Mention tags in README.org template 2019-04-21 22:09:34 +03:00
JAremko
d8addb1674 Improve README.org template 2017-08-02 20:42:12 +03:00
JAremko
106f98497e Update README.org template
Replace some local Org links with GitHub ones
2017-07-23 01:22:20 +03:00
JAremko
de0f8ff677 Add space-doc link examples to README.org.template 2016-04-12 23:11:26 -04:00
Robert Johnson
16e1be2691 Fix inconsistent notation of SPC key in docs
Replace all occurrences of <SPC> in org files with SPC.

Fixes syl20bnr/spacemacs#1823
2016-04-05 12:46:10 +02:00
JAremko
919a960fc2 update README.org.template to the new convention
Remove #+HTML_HEAD_EXTRA: <link ... /readtheorg.css" />

:TOC_4_org:noexport: -> :TOC_4_gh:noexport:
2016-03-30 22:40:16 -04:00
syl20bnr
9bd6078cc5 Update README.org template for layers 2016-03-21 20:04:38 -04:00
Chris Barrett
6d7d399cfe Update packages.el template
- Remove extensions template
- Prompt before creating readme (Users creating private layers probably
  don't want to create a readme)
- Template out layer author and email address
- Rename LAYERNAME to LAYER_NAME for readability
- Use fallback attributes if user-full-name is unset
- Fix inconsistent Spacemacs capitalization in template
2016-01-11 19:06:43 -05:00
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
c893383fe4 Fix some documentation bugs
- CSS links
- GIFS in published version
- Unify layer doc titles
- Change emoji layer emojis to an image
2015-12-03 23:50:29 -05:00
Fabien Dubosson
028c53fbd7 Create the layer README on create-layer
When using `configuration-layer/create-layer`, the `README.org` file is
not created from the template. This change corrects this.

Close #3259
2015-11-24 23:20:45 +01:00
Renamed from core/templates/layer-README.template (Browse further)