• Stars
    star
    209
  • Rank 188,325 (Top 4 %)
  • Language
    Haskell
  • Created over 9 years ago
  • Updated over 2 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Repository for collaborative Haskell documentation

Build Status

NOTE This repository has not seen a lot of activity recently. Instead, most new documentation is being written for the haskell-lang project (live site]). We recommend contributing there.

This repository is an implementation of the intermediate Haskell documentation proposal. The goal is to have a repository where any documentation can be added, collaboratively maintained, and linked together in various outlines to provide a structured learning experience. Concretely: while the original proposal was specifically to enable "intermediate Haskell documentation," this repository is intended to support any kind of documentation.

All content is automatically uploaded to School of Haskell by a Travis job for easier reading.

Licensing

All content in this repository is licensed Attribution 4.0 International (CC BY 4.0). By pushing content into this repository or sending a pull request, you are implicitly assigning that license to the content.

Commit access

The goal of this repository is to be incredibly open about allowing contributors. If you would like to participate, open an issue asking for commit access, and odds are it will be granted. Similarly, odds are pretty high that just by sending a pull request you will be granted commit access.

The general guidelines for how to treat your access is:

  • Any content for which you are the primary author, you should feel free to make any changes to. If the changes are significant, feel free to reach out to others for feedback.

  • You are free to make minor modifications and corrections to any content in this repository, without consulting the original author. For more significant changes, it is an expected courtesy to touch base with the author. If the author appears to be non-responsive, check with others and, if there's general consensus, move ahead with the changes.

  • Merging pull requests applies the same logic as above. If the changes are minor or on your content, you may always do it. If they're significant, check with the author.

Structure

There are three main directories in this repository:

  • content contains all of the raw content. See the CONTENT.md file for an example of what the content should look like.
  • outline contains various outlines of the content. See the OUTLINE.md file for an example of what outlines should look like.
  • src contains various tooling to go along with this repository.

The files in content and outline should be kept in a flat structure, i.e. no suubdirectories. Every file must end with a .md file extension. The result of this is that each content and outline file will have a unique identifier in the form of the filename, which can be used for linking.

Linking

We should use standard Markdown linking conventions as relative paths. For example:

  • To link to a content file from another content file, the link would be [link text](destination.md).
  • To link to a content file from an outline file, the link would be [link text](../outline/destination.md).

As a special feature, we should provide tooling that automatically fills in link text when not provided by grabbing the title from the destination. This would be triggered by having a link such as: [insert-title](destination.md).

Embedding?

This is not currently supported. We may consider allowing importing of content from another file at some point in the future.

Authoring guidelines

For now, please see the original proposal for some recommendations on quality. Eventually, those guidelines should be moved into this document.

Wikis

Essentially this is a wiki for intermediate Haskell documentation.

There is an important difference between wikis and github. Most wikis are oddly horrible for discussing content, so they actually don't scale well beyond 1 contributor per page (Wikipedia is a total disaster in this regard, but worse is better). Pull requests are much easier to work with than most wiki systems. They make it clear that people are notified about changes and contributions are discussed (with line comments) before being committed.

More Repositories

1

stack

The Haskell Tool Stack
Haskell
3,995
star
2

rio

A standard library for Haskell
Haskell
839
star
3

stackage

Stable Haskell package sets: vetted consistent packages from Hackage
Dockerfile
529
star
4

commercialhaskell

A special interest group for companies and individuals interested in commercial usage of Haskell
452
star
5

stack-templates

Project templates for stack new
Haskell
233
star
6

lts-haskell

LTS Haskell build plans
Shell
159
star
7

jump

Jump start your Haskell development
158
star
8

haskellers

haskellers.com site
Haskell
141
star
9

path

Typed filepath
Haskell
123
star
10

stackage-server

Server for stable, curated Haskell package sets
Haskell
106
star
11

stack-ide

Stack-based JSON interface to ide-backend
Emacs Lisp
98
star
12

describe

Describe Haskell code in GHCi
PowerShell
72
star
13

casa

Content Addressable Storage Archive
Haskell
41
star
14

pantry

Haskell
39
star
15

all-cabal-hashes

A repository containing all cabal files, with added metadata for package hashes
21
star
16

stackage-snapshots

LTS Haskell and Stackage Nightly snapshot configurations (experimental, for pantry)
Haskell
14
star
17

stackage-content

Content for the stackage.org site
HTML
10
star
18

stackage-nightly

Collection of bundle files for Stackage Nightly builds
10
star
19

all-cabal-metadata

Current metadata for all cabal files
Shell
9
star
20

curator

Haskell Stackage curator build tool
Haskell
8
star
21

all-cabal-files

A repository containing all of the cabal files for all public Haskell packages
8
star
22

state-of-haskell

State of Haskell survey
4
star
23

all-cabal-tool

Update the various all-cabal-* repos
Haskell
4
star
24

hi-file-parser

Haskell
4
star
25

http-download

Haskell
3
star
26

sig-service

Signing service for easily uploading/downloading signatures to the signature index at sig-archive
Haskell
3
star
27

commercialhaskell.com

Codebase for commercialhaskell.com
HTML
3
star
28

sig-tool

Tool for signing, verifying and installing signed packages from sig-archive
Haskell
2
star
29

rio-prettyprint

Haskell
2
star
30

core-cabal-files

Cabal files for packages that ship with GHC but aren't present on Hackage
2
star
31

all-cabal-metadata-tool

Tool for extracting metadata on all packages
1
star
32

stackage-constraints

1
star
33

all-cabal-hashes-tool

Tool for creating the all-cabal-hashes repository
Haskell
1
star
34

devops

Smarty
1
star