You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
append documentation TOC to root README
update downloads links in README to use doc/, not wiki
convert (user) guide link in README to a relative link
update faq link in README
insert offsite stack tutorial link (from the former
Wiki Home page) into (USER) GUIDE
Note: if you are using cabal-install to install stack, you may need to pass a constraint to work around a [Cabal issue](https://github.com/haskell/cabal/issues/2759): `cabal install --constraint 'mono-traversable >= 0.9' stack`.
36
36
@@ -80,15 +80,14 @@ git clone https://github.com/commercialhaskell/stack.git && cd stack && stack se
80
80
81
81
#### Complete guide to stack
82
82
83
-
This repository also contains [a complete guide to using
which rated build issues as a major concern. The stack team hopes that stack
118
117
can address these concerns.
118
+
119
+
<hr>
120
+
121
+
## Documentation Table Of Contents
122
+
123
+
* Project Documentation
124
+
*[Maintainer Guide](doc/MAINTAINER_GUIDE.md): includes releasing information
125
+
*[Signing Key](doc/SIGNING_KEY.md): downloadable stack binaries are signed with this key
126
+
* Tool Documentation
127
+
*[Architecture](doc/architecture.md): reference for people curious about stack internals, wanting to get involved deeply in the codebase, or wanting to use stack in unusual ways
128
+
*[Build Command](doc/build_command.md): reference for the syntax of the build command and the command line targets
*[User Guide](doc/GUIDE.md): in-depth tutorial covering the most common use cases and all major stack features (requires no prior Haskell tooling experience)
141
+
*[YAML Configuration](doc/yaml_configuration.md): reference for writing `stack.yaml` files
142
+
* Historical/Deprecated Tool Documentation (subject to removal)
143
+
*[Proto-User Guide: Script Interpreter](doc/usr_script_interpreter.md): mostly superseded by the User Guide
144
+
*[Proto-User Guide: Transition Guide](doc/usr_transition_guide.md): mostly superseded by the User Guide
0 commit comments