@@ -116,24 +116,36 @@ confirmation and we will close it.
116
116
117
117
## Documentation
118
118
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
122
133
[ pull request] ( https://help.github.com/articles/using-pull-requests/ ) with your
123
134
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 ) .
125
136
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 .
130
141
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 .
136
147
148
+ The configuration file for MkDocs is ` mkdocs.yml ` .
137
149
138
150
## Code
139
151
0 commit comments