update CONTRIBUTING guide, and remove info from README #1512
Conversation
All README info is now on the website.
Well, that's a good point. But as a counterpoint, the reason I got rid of everything is that I'd rather have only a single "source of truth". If some information is duplicated in the README and the website, it is going to get out of sync. I'd rather not have to remember to update both places. If there's a simple way to have the information stored in only one place and automatically referenced in both places, that would be fantastic, but I can't think of any off the top of my head. @kostmo , any thoughts? |
I also tend to weight this more heavily. An offline-available doc is less valuable if it is not enforced to be in sync. How does the website deployment work? Can a copy of it be downloaded and viewed locally? |
Yes, Hakyll just generates all the static HTML, CSS, etc. into the |
| supports `terminfo`. Linux and MacOS should work out of the box. On | ||
| Windows, you will need to use [Windows Subsystem for | ||
| Linux](https://learn.microsoft.com/en-us/windows/wsl/); you should | ||
| then be able to follow instructions for installing on Linux. |
There was a problem hiding this comment.
Specifically these two notes make more sense to me in swarm repo rather than the website repo.
I can’t imagine going to a website to check if there are any notes for compiling with specific GHC versions.
There was a problem hiding this comment.
Yes, I agree those notes feel like maybe they don't belong on the website. How about I put all the instructions for building from source in the repo, and leave the other stuff on the website (with appropriate links)? Let me try that and see how it looks.
There was a problem hiding this comment.
@xsebek What do you think now?
Note, I simply removed the note about GHC 9.2. By now it's pretty old, and since we're recommending building with stack (which will now get GHC 9.4) no one would run into this issue unless they (1) want to use their own custom workflow for building via cabal or whatever, AND (2) are still using GHC 9.2, which seems like a very unlikely combination.
|
@byorgey we could setup this action in main branch that would keep Markdown files in sync: https://github.com/marketplace/actions/push-a-file-to-another-repository |
That's nifty, but it seems like more trouble than it's worth. We probably won't want the files to have exactly the same format, etc. etc. |
All README info is now on the website.