Skip to content

Commit eed1073

Browse files
ktsiligkirisbiern
authored andcommitted
Fix contribute.md minor issues
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.)
1 parent 935abe2 commit eed1073

File tree

1 file changed

+20
-18
lines changed

1 file changed

+20
-18
lines changed

docs/contributing.md

+20-18
Original file line numberDiff line numberDiff line change
@@ -2,41 +2,43 @@
22

33
## Issues
44

5-
Report issues and suggest features and improvements on the
6-
[GitHub issue tracker](https://github.com/bbatsov/prelude/issues). Don't ask
7-
questions on the issue tracker - use the [support channels](support.md) instead.
5+
Report issues and suggest features and improvements on the [GitHub
6+
issue tracker](https://github.com/bbatsov/prelude/issues). Don't ask
7+
questions on the issue tracker - use the [support
8+
channels](support.md) instead.
89

9-
If you want to file a bug, please provide all the necessary info listed in
10-
our issue reporting template (it's loaded automatically when you create a
11-
new GitHub issue).
10+
If you want to file a bug, please provide all the necessary info
11+
listed in our issue reporting template (it's loaded automatically when
12+
you create a new GitHub issue).
1213

1314
## Patches
1415

15-
Patches in any form are always welcome! GitHub pull requests are even better! :-)
16+
Patches in any form are always welcome! GitHub pull requests are even
17+
better! :-)
1618

1719
Before submitting a patch or a pull request make sure that your patch
1820
is in line with the [contribution
1921
guidelines](https://github.com/bbatsov/prelude/blob/master/CONTRIBUTING.md).
2022

2123
## Documentation
2224

23-
Good documentation is just as important as good code.
24-
Please, consider improving and extending this manual.
25+
Good documentation is just as important as good code. Please,
26+
consider improving and extending this manual.
2527

2628
### Working on the Manual
2729

2830
The manual is generated from the markdown files in the
29-
[doc](https://github.com/bbatsov/prelude/tree/master/doc) folder of Prelude's
30-
GitHub repo and is published to [Read the Docs](readthedocs.org). The
31-
[MkDocs](http://www.mkdocs.org/) tool is used to convert the markdown sources to
32-
HTML.
31+
[docs](https://github.com/bbatsov/prelude/tree/master/docs) folder of
32+
Prelude's GitHub repo and is published to [Read the
33+
Docs](https://readthedocs.org). The [MkDocs](http://www.mkdocs.org/)
34+
tool is used to convert the markdown sources to HTML.
3335

34-
To make changes to the manual you simply have to change the files under
35-
`doc`. The manual will be regenerated automatically when changes to those files
36-
are merged in `master` (or the latest stable branch).
36+
To make changes to the manual you simply have to change the files
37+
under `docs`. The manual will be regenerated automatically when changes
38+
to those files are merged in `master` (or the latest stable branch).
3739

38-
You can install `MkDocs` locally and use the command `mkdocs serve` to see the
39-
result of changes you make to the manual locally:
40+
You can install `MkDocs` locally and use the command `mkdocs serve` to
41+
see the result of changes you make to the manual locally:
4042

4143
```sh
4244
$ cd path/to/prelude/repo

0 commit comments

Comments
 (0)