jt/emacs-prelude
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Fix contribute.md minor issues

Browse source 
Fixed link to readthedocs.org (it didn't work correctly in the site)
and changed the documentation forlder from doc to docs (according to
other changes I have proposed.)
This commit is contained in:
Kostas Tsiligkiris 2022-02-20 15:04:22 +02:00 committed by Bozhidar Batsov
parent a8a5f244e1
commit 7bca056c46
1 changed files with 20 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
docs/contributing.md
View file

@ -2,17 +2,19 @@
## Issues ## Issues
Report issues and suggest features and improvements on the Report issues and suggest features and improvements on the [GitHub
[GitHub issue tracker](https://github.com/bbatsov/prelude/issues). Don't ask issue tracker](https://github.com/bbatsov/prelude/issues). Don't ask
questions on the issue tracker - use the [support channels](support.md) instead. questions on the issue tracker - use the [support
channels](support.md) instead.
If you want to file a bug, please provide all the necessary info listed in If you want to file a bug, please provide all the necessary info
our issue reporting template (it's loaded automatically when you create a listed in our issue reporting template (it's loaded automatically when
new GitHub issue). you create a new GitHub issue).
## Patches ## Patches
Patches in any form are always welcome! GitHub pull requests are even better! :-) Patches in any form are always welcome! GitHub pull requests are even
better! :-)
Before submitting a patch or a pull request make sure that your patch Before submitting a patch or a pull request make sure that your patch
is in line with the [contribution is in line with the [contribution
@ -20,23 +22,23 @@ guidelines](https://github.com/bbatsov/prelude/blob/master/CONTRIBUTING.md).
## Documentation ## Documentation
Good documentation is just as important as good code. Good documentation is just as important as good code. Please,
Please, consider improving and extending this manual. consider improving and extending this manual.
### Working on the Manual ### Working on the Manual
The manual is generated from the markdown files in the The manual is generated from the markdown files in the
[doc](https://github.com/bbatsov/prelude/tree/master/doc) folder of Prelude's [docs](https://github.com/bbatsov/prelude/tree/master/docs) folder of
GitHub repo and is published to [Read the Docs](readthedocs.org). The Prelude's GitHub repo and is published to [Read the
[MkDocs](http://www.mkdocs.org/) tool is used to convert the markdown sources to Docs](https://readthedocs.org). The [MkDocs](http://www.mkdocs.org/)
HTML. tool is used to convert the markdown sources to HTML.
To make changes to the manual you simply have to change the files under To make changes to the manual you simply have to change the files
`doc`. The manual will be regenerated automatically when changes to those files under `docs`. The manual will be regenerated automatically when changes
are merged in `master` (or the latest stable branch). to those files are merged in `master` (or the latest stable branch).
You can install `MkDocs` locally and use the command `mkdocs serve` to see the You can install `MkDocs` locally and use the command `mkdocs serve` to
result of changes you make to the manual locally: see the result of changes you make to the manual locally:
```sh ```sh
$ cd path/to/prelude/repo $ cd path/to/prelude/repo