Skip to content
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

Merged
merged 1 commit into from Dec 17, 2016
Merged

Update links to wiki #2476

merged 1 commit into from Dec 17, 2016

Conversation

LiamGoodacre
Copy link
Member

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?

@hdgarrood
Copy link
Contributor

👍 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.

@LiamGoodacre
Copy link
Member Author

I've updated some more references to the wiki.

Yes that makes sense, thanks for the feedback :)

@paf31
Copy link
Contributor

paf31 commented Dec 11, 2016

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!

@hdgarrood
Copy link
Contributor

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?

@LiamGoodacre
Copy link
Member Author

Adding everything into the main repo means we can start to document all new features as we implement them, not just errors.

@hdgarrood
Copy link
Contributor

See also my comment on this topic from earlier, in #2455.

@paf31
Copy link
Contributor

paf31 commented Dec 12, 2016

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:

  • Compiler repo, for docs which are relevant to some versioned part of the compiler (executables, errors, etc.)
  • Wiki, for the few things which are specific to some external group, like online meetups or conferences
  • Documentation repo, for everything else (this basically means everything which is a guide or article in the docs repo right now)

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.

@hdgarrood
Copy link
Contributor

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:

  • I'd rather not have a wiki at all, just because it's so easy for misleading or duplicated information to appear on new wiki pages, and then stay there for a while before anyone who would know how to correct it stumbles upon it. Perhaps information regarding separate meetup groups or conferences should go elsewhere, like say, their own repositories, and we can link to those repositories where appropriate?
  • If we are going to split the documentation repo up as you've suggested, perhaps it would make more sense to just put the rest on the website, purescript.org, and not have an independent documentation repo? As far as I can tell, the website does currently contain everything that you've put in the "documentation repo" category.

@paf31
Copy link
Contributor

paf31 commented Dec 17, 2016

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!

@paf31 paf31 merged commit 612585a into purescript:master Dec 17, 2016
@LiamGoodacre LiamGoodacre deleted the fix/wiki-links branch December 17, 2016 18:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants