Skip to content

Add link to purescript-jordans-reference in Learning section #220

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

Merged
merged 3 commits into from
Dec 15, 2018
Merged

Add link to purescript-jordans-reference in Learning section #220

merged 3 commits into from
Dec 15, 2018

Conversation

JordanMartinez
Copy link
Contributor

I opened #216 but never got a response. So, I'm trying this approach instead.

@chexxor
Copy link
Collaborator

chexxor commented Dec 9, 2018

I'm in favor of linking to other people's documentation project's, especially if they are relatively well-organized and have good content. Content from other people's projects can be referenced by contributors to this project, when and if that happens.

@hdgarrood
Copy link
Collaborator

Sorry for the delay in responding. The reason it's taken a while is that before linking to things, I'd really want to make sure we've had a good look at them first, and your repo has a decent amount of stuff in it.

I'm happy to put links to unofficial documentation resources in here, but I'd prefer that we clearly separated them from any official documentation and added a note to clarify that they are unofficial.

Content from other people's projects can be referenced by contributors to this project, when and if that happens.

I'm not super keen on this, as it happens; we have enough trouble keeping links between official resources alive as it is, and any references to unofficial resources are even more likely to change under us.

@chexxor
Copy link
Collaborator

chexxor commented Dec 9, 2018

I'm not super keen on this, as it happens; we have enough trouble keeping links between official resources alive as it is, and any references to unofficial resources are even more likely to change under us.

I should have clarified that - I mean that when people are aiming to write new documentation for this purescript/documentation project, they can browse through other people's doc projects to find docs to start from.

@JordanMartinez
Copy link
Contributor Author

One thought that's also been on my mind. Since my repo is "unofficial", what if I just contributed a large portion of it to this repo? There might be some maintenance concerns, but it's a thought that's been on my mind.

@chexxor
Copy link
Collaborator

chexxor commented Dec 9, 2018

I think the maintainers of the purescript/documentation project want to keep the scope relatively manageable. I think this means compiler docs and some core tools docs -- mostly just reference documentation, not walkthroughs or how to FP design patterns.

@JordanMartinez
Copy link
Contributor Author

Good points!

@JordanMartinez
Copy link
Contributor Author

JordanMartinez commented Dec 11, 2018 via email

@chexxor
Copy link
Collaborator

chexxor commented Dec 14, 2018

@JordanMartinez Is it still on your radar to add a patch to address the comment I made on your addition?

@JordanMartinez
Copy link
Contributor Author

Oh, I thought we were still determining what the description of the link should say. So, I was waiting for others to say "how about 'x'" or something.

Since it's been a while since I've looked at this, what needs to be changed/fixed for this to be merged?

@JordanMartinez
Copy link
Contributor Author

Let me know if there's anything else that needs to be done.

@chexxor
Copy link
Collaborator

chexxor commented Dec 14, 2018

LGTM - I'll merge in several hours, to give time for comments.
It might be a good idea to put a disclaimer on references to docs outside this one, but we can address that in a separate issue/PR.

@chexxor chexxor merged commit 7c4ff65 into purescript:master Dec 15, 2018
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.

3 participants