Skip to content

Commit 7eb5b18

Browse files
committed
Update 'Documentation' section in CONTRIBUTING.md
Also fixes `edit_url:` in `mkdocs.yml`.
1 parent 94bea79 commit 7eb5b18

File tree

3 files changed

+26
-15
lines changed

3 files changed

+26
-15
lines changed

CONTRIBUTING.md

Lines changed: 25 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -116,24 +116,36 @@ confirmation and we will close it.
116116

117117
## Documentation
118118

119-
If you would like to help with documentation, please note that for most cases
120-
the Wiki has been deprecated in favor of markdown files placed in a new `/doc`
121-
subdirectory of the repository itself. Please submit a
119+
The files which make up Stack's documentation are located in the `doc`
120+
directory of the repository. They are formatted in the
121+
[Markdown syntax](https://daringfireball.net/projects/markdown/), with some
122+
extensions.
123+
124+
Those files are rendered on [haskellstack.org](http://haskellstack.org) by
125+
[Read the Docs](https://readthedocs.org/) using
126+
[MkDocs](https://www.mkdocs.org/). The `stable` branch of the repository
127+
provides the 'stable' version of the online documentation. The `master` branch
128+
provides the 'latest' version of the documentation.
129+
130+
The 'stable' version of the online documentation is intended to be applicable to
131+
the latest released version of Stack. If you would like to help with that
132+
documentation, please submit a
122133
[pull request](https://help.github.com/articles/using-pull-requests/) with your
123134
changes/additions based off the
124-
[the stable branch](https://github.com/commercialhaskell/stack/tree/stable).
135+
[stable branch](https://github.com/commercialhaskell/stack/tree/stable).
125136

126-
The documentation is rendered on [haskellstack.org](http://haskellstack.org) by
127-
readthedocs.org using Sphinx and CommonMark. Since links and formatting vary
128-
from GFM, please check the documentation there before submitting a PR to fix
129-
those.
137+
The specific versions of the online documentation (eg `v: v2.7.5`) are generated
138+
from the content of files at the point in the responsitory's history specified
139+
by the corresponding release tag. Consequently, that content is fixed once
140+
released.
130141

131-
If your changes move or rename files, or subsume Wiki content, please continue
132-
to leave a file/page in the old location temporarily, in addition to the new
133-
location. This will allow users time to update any shared links to the old
134-
location. Please also update any links in other files, or on the Wiki, to point
135-
to the new file location.
142+
The Markdown syntax supported by MkDocs can differ from the GitHub Flavored
143+
Markdown ([GFM](https://github.github.com/gfm/)) supported for content on
144+
GitHub.com. Please refer to the
145+
[MkDocs documentation](https://www.mkdocs.org/user-guide/writing-your-docs/#writing-with-markdown)
146+
to ensure your pull request will achieve the desired rendering.
136147

148+
The configuration file for MkDocs is `mkdocs.yml`.
137149

138150
## Code
139151

doc/GUIDE.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1804,7 +1804,6 @@ There are lots of resources available for learning more about Stack:
18041804
* The [home page](http://haskellstack.org)
18051805
* The [Stack mailing list](https://groups.google.com/d/forum/haskell-stack)
18061806
* The [FAQ](faq.md)
1807-
* The [Stack wiki](https://github.com/commercialhaskell/stack/wiki)
18081807
* The [haskell-stack tag on Stack Overflow](http://stackoverflow.com/questions/tagged/haskell-stack)
18091808
* [Another getting started with Stack tutorial](http://seanhess.github.io/2015/08/04/practical-haskell-getting-started.html)
18101809
* [Why is Stack not Cabal?](https://www.fpcomplete.com/blog/2015/06/why-is-stack-not-cabal)

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ site_name: The Haskell Tool Stack
22
site_description: The Haskell Tool Stack
33
site_author: Stack contributors
44
repo_url: https://github.com/commercialhaskell/stack/
5-
edit_uri: edit/stable/doc/
5+
edit_uri: tree/stable/doc/
66
copyright: Copyright (c) 2015-2022, Stack contributors
77
docs_dir: doc
88
site_dir: _site

0 commit comments

Comments
 (0)