TryGhost/Ghost
1
0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2024-11-27 10:42:45 +03:00
Code Issues Projects Releases Wiki Activity

Improve documentation section in CONTRIBUTING.md

Browse Source
This commit is contained in:
Hannah Wolfe 2014-08-15 09:37:02 +01:00
parent 868219d0a9
commit 91ef11f853
1 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
CONTRIBUTING.md
View File

@ -158,20 +158,23 @@ repository to allow you to checkout pull requests in the same way as branches:
<a name="documentation"></a> <a name="documentation"></a>
### Documentation ### Documentation
Ghost's documentation can be found at [support.ghost.org](http://support.ghost.org). Ghost's user documentation can be found at [support.ghost.org](http://support.ghost.org), if you're interested in submitting user documentation, please let us know by [emailing support](mailto:support@ghost.org).
The documentation is generated using jekyll, all of the docs are on the gh-pages branch on the GitHub repository. Ghost's developer documentation can be found at [docs.ghost.org](http://docs.ghost.org).
You can clone the repo, checkout the gh-pages branch, and submit pull requests following
the [pull-request](#pull-requests) guidelines.
This documentation is written in markdown and generated using jekyll via GitHub pages, meaning the documentation can be found on the [gh-pages branch](https://github.com/TryGhost/Ghost/tree/gh-pages) of the GitHub repository.
For small changes, it is possible to edit the files directly and submit a PR through GitHub. For larger changes, you can clone the gh-pages branch using the command:
`git clone -b gh-pages git@github.com:TryGhost/Ghost.git`
Please follow the [pull-request](#pull-requests) guidelines for submitting PRs.
<a name="translation"></a> <a name="translation"></a>
### Translation ### Translation
Full documentation on contributing translations can be found at <http://docs.ghost.org/translations> Full documentation on contributing translations can be found at <http://docs.ghost.org/translations>
<a name="core"></a> <a name="core"></a>
## Working on Ghost Core ## Working on Ghost Core