New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update links to wiki #2476
Update links to wiki #2476
Conversation
👍 Except the sentence that mentions the PureScript wiki probably wants updating too, as it's no longer a wiki. I think we should probably keep pointing at master for the time being, since we haven't yet started supporting older versions of the compiler, and since documentation relevant to a particular release is often updated after that release is made. |
I've updated some more references to the wiki. Yes that makes sense, thanks for the feedback :) |
I think I would prefer it if we put the error message docs in the compiler repo, and require that anyone making error messages PRs actually update the docs at the same time. What do we think? @LiamGoodacre Thanks for working on this! |
I don't feel strongly either way but I think it might be nice to keep all the docs (i.e. what's currently in the documentation repo) together. If we are putting error message docs in the compiler repo, might it also make sense to put everything else that's currently in the documentation repo back in the compiler repo too? |
Adding everything into the main repo means we can start to document all new features as we implement them, not just errors. |
See also my comment on this topic from earlier, in #2455. |
I don't think everything belongs in the compiler repo. Take the wiki page about meetups for example. I think there are three possible places:
I don't feel strongly about this break-down at all, but I think it's one way we could do it where we minimize the amount of fuss for non-compiler related things, and keep compiler-related things in sync with the compiler. |
I actually have exams in the next couple of weeks so I won't be able to devote much time to purescript things between now and Christmas. Please feel free to rearrange documentation however seems reasonable without waiting for my input in the meantime. Just a couple of things that I'd like to add:
|
Let's stick with the docs repo for now, and we can always move them into the compiler repo later, maybe once they've been tidied up a bit. Thanks @LiamGoodacre! |
The compiler still displays links to all of these:
However we are moving to use the purescript/documentation repo.
Also do you think it makes sense to tag releases on the documentation repo and have the compiler point at specific versions, instead of always pointing at master?