haskell / happy

The Happy parser generator for Haskell
Other
291 stars 84 forks source link

Deduplicate docs, prepare to get rid of website #243

Closed Ericson2314 closed 2 years ago

Ericson2314 commented 2 years ago

The idea is that the docs should the source of truth, and be able to replace the website.

Information from the read-me is also moved to the docs.

The CONTRIBUTING.rst symlink is intended to do a thing on GitHub (see https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors), but I am not sure how to confirm it will short of merging this PR.

Some bits taken from this analogous PR for Alex: https://github.com/haskell/alex/pull/219

Ericson2314 commented 2 years ago

Docs rendered at https://haskell-happy.readthedocs.io/en/refactor-read-docs-website