Skip to content

Commit 56d04db

Browse files
author
Derrick G
committed
documentation cleanup phase 2
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
1 parent c1941dc commit 56d04db

File tree

2 files changed

+44
-15
lines changed

2 files changed

+44
-15
lines changed

README.md

Lines changed: 41 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,16 @@ It features:
2121

2222
Downloads are available by operating system:
2323

24-
* [Windows](https://github.com/commercialhaskell/stack/wiki/Downloads#windows)
25-
* [OS X](https://github.com/commercialhaskell/stack/wiki/Downloads#os-x)
26-
* [Ubuntu](https://github.com/commercialhaskell/stack/wiki/Downloads#ubuntu)
27-
* [Debian](https://github.com/commercialhaskell/stack/wiki/Downloads#debian)
28-
* [CentOS / Red Hat / Amazon Linux](https://github.com/commercialhaskell/stack/wiki/Downloads#centos--red-hat--amazon-linux)
29-
* [Fedora](https://github.com/commercialhaskell/stack/wiki/Downloads#fedora)
30-
* [Arch Linux](https://github.com/commercialhaskell/stack/wiki/Downloads#arch-linux)
31-
* [Linux (general)](https://github.com/commercialhaskell/stack/wiki/Downloads#linux)
24+
* [Windows](doc/install_and_upgrade.md#windows)
25+
* [OS X](doc/install_and_upgrade.md#os-x)
26+
* [Ubuntu](doc/install_and_upgrade.md#ubuntu)
27+
* [Debian](doc/install_and_upgrade.md#debian)
28+
* [CentOS / Red Hat / Amazon Linux](doc/install_and_upgrade.md#centos--red-hat--amazon-linux)
29+
* [Fedora](doc/install_and_upgrade.md#fedora)
30+
* [Arch Linux](doc/install_and_upgrade.md#arch-linux)
31+
* [Linux (general)](doc/install_and_upgrade.md#linux)
3232

33-
[Upgrade instructions](https://github.com/commercialhaskell/stack/wiki/Downloads#upgrade)
33+
[Upgrade instructions](doc/install_and_upgrade.md#upgrade)
3434

3535
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`.
3636

@@ -80,15 +80,14 @@ git clone https://github.com/commercialhaskell/stack.git && cd stack && stack se
8080

8181
#### Complete guide to stack
8282

83-
This repository also contains [a complete guide to using
84-
stack](https://github.com/commercialhaskell/stack/blob/master/doc/GUIDE.md),
85-
covering all of the most common use cases.
83+
This repository also contains a complete [user guide to using stack
84+
](doc/GUIDE.md), covering all of the most common use cases.
85+
8686

8787
#### Questions, Feedback, Discussion
8888

89-
* For frequently asked questions about detailed or specific use-cases,
90-
please see
91-
[the FAQ](https://github.com/commercialhaskell/stack/wiki/FAQ).
89+
* For frequently asked questions about detailed or specific use-cases, please
90+
see [the FAQ](doc/faq.md).
9291
* For general questions, comments, feedback and support please write
9392
to [the stack mailing list](https://groups.google.com/d/forum/haskell-stack).
9493
* For bugs, issues, or requests please
@@ -116,3 +115,30 @@ in
116115
Haskell](https://www.fpcomplete.com/blog/2015/05/thousand-user-haskell-survey),
117116
which rated build issues as a major concern. The stack team hopes that stack
118117
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
129+
* [Custom Snapshots](doc/custom_snapshots.md)
130+
* [Dependency Visualization](doc/dependency_visualization.md): uses Graphviz
131+
* [Docker Integration](doc/docker_integration.md)
132+
* [FAQ](doc/faq.md): frequently asked questions about detailed or specific use-cases
133+
* [Haskell Newcomers](doc/haskell_newcomers.md)
134+
* [Install/Upgrade](doc/install_and_upgrade.md): a list of downloads available by operating system, installation instructions, and upgrade instructions
135+
* [Lowering The Bar For Contributions To Open-Source Software](doc/oss_contribs_bar_lowered.md)
136+
* [Nonstandard Project Initialization](doc/nonstandard_project_init.md)
137+
* [Origins Of Stack](doc/origins_of_stack.md)
138+
* [Shell Autocompletion](doc/shell_autocompletion.md)
139+
* [Travis Integration](doc/travis_integration.md)
140+
* [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

doc/GUIDE.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1516,6 +1516,9 @@ There are lots of resources available for learning more about stack:
15161516
* The [stack wiki](https://github.com/commercialhaskell/stack/wiki),
15171517
* in particular [the FAQ page](https://github.com/commercialhaskell/stack/wiki/FAQ)
15181518
* The [haskell-stack tag on Stack Overflow](http://stackoverflow.com/questions/tagged/haskell-stack)
1519+
* [Another getting started with stack tutorial](http://seanhess.github.io/2015/08/04/practical-haskell-getting-started.html)
1520+
* [Why is stack not cabal?](https://www.fpcomplete.com/blog/2015/06/why-is-stack-not-cabal)
1521+
15191522
15201523
## Fun features
15211524

0 commit comments

Comments
 (0)