@@ -113,7 +113,6 @@ you. Once you have tested and confirmed that the issue is resolved, close the
113
113
issue. If you are not a member of the project, you will be asked for
114
114
confirmation and we will close it.
115
115
116
-
117
116
## Documentation
118
117
119
118
The files which make up Stack's documentation are located in the ` doc `
@@ -142,11 +141,20 @@ released.
142
141
The Markdown syntax supported by MkDocs can differ from the GitHub Flavored
143
142
Markdown ([ GFM] ( https://github.github.com/gfm/ ) ) supported for content on
144
143
GitHub.com. Please refer to the
145
- [ MkDocs documentation] ( https://www.mkdocs.org/user-guide/writing-your-docs/#writing-with-markdown )
144
+ [ MkDocs documentation] ( https://www.mkdocs.org/user-guide/writing-your-docs/#writing-with-markdown )
146
145
to ensure your pull request will achieve the desired rendering.
147
146
148
147
The configuration file for MkDocs is ` mkdocs.yml ` .
149
148
149
+ The files in the ` doc ` directory of the repository include two symbolic links
150
+ (symlinks), ` ChangeLog.md ` and ` CONTRIBUTING.md ` . Users of Git on Windows should
151
+ be aware of its approach to symbolic links. See the
152
+ [ Git for Windows Wiki] ( https://github.com/git-for-windows/git/wiki/Symbolic-Links ) .
153
+ If ` git config --show-scope --show-origin core.symlinks ` is ` false ` in a local
154
+ repository on Windows, then the files will be checked out as small plain files
155
+ that contain the link text See the
156
+ [ Git documentation] ( https://git-scm.com/docs/git-config#Documentation/git-config.txt-coresymlinks ) .
157
+
150
158
## Code
151
159
152
160
If you would like to contribute code to fix a bug, add a new feature, or
0 commit comments