Deduplicate docs, prepare to get rid of website #219
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The idea is that the docs should the source of truth, and be able to replace the website (#215). 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.
|
Docs are rendered at https://haskell-alex.readthedocs.io/en/refactor-read-docs-website/ |
andreasabel
reviewed
Nov 15, 2022
|
Look good now, @andreasabel? |
andreasabel
reviewed
Nov 21, 2022
Co-Authored-By: Andreas Abel <andreas.abel@ifi.lmu.de>
Ericson2314
added a commit
to haskell/happy
that referenced
this pull request
Nov 22, 2022
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: haskell/alex#219
Ericson2314
added a commit
to haskell/happy
that referenced
this pull request
Nov 22, 2022
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: haskell/alex#219
|
Thanks for your good work, @Ericson2314 ! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The idea is that the docs should the source of truth, and be able to replace the website (#215).
Information from the read-me is also moved to the docs.
The
CONTRIBUTING.rstsymlink 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.