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 the README to point very clearly to the wiki #60

Closed
KirstieJane opened this issue Jun 15, 2018 · 5 comments
Closed

Update the README to point very clearly to the wiki #60

KirstieJane opened this issue Jun 15, 2018 · 5 comments
Assignees
Labels
closing soon issues that are about to be closed...speak up now! community tasks relating to community development and support documentation tasks relating to improving our documentation enhancement requests to add something new to the project

Comments

@KirstieJane
Copy link
Member

At the moment the README contains lots of great information and it does technically link to the wiki, but I don't think it is very clear that there is LOTS more information in the wiki!

So somewhere in the README we need to have a section on (something like) "how do I find information" that highlights the wiki (and potentially contains the answer to #57

@KirstieJane KirstieJane added enhancement requests to add something new to the project community tasks relating to community development and support documentation tasks relating to improving our documentation labels Jun 15, 2018
@emdupre
Copy link
Collaborator

emdupre commented Jul 10, 2018

What about putting this in project summary ? I think there could be subheadings there !

@patrick-g-h
Copy link
Collaborator

Fair enough! So under the project summary I'll explicitly mention and link to some of the main subpages in the wiki

@emdupre
Copy link
Collaborator

emdupre commented Jul 10, 2018

I say yes ! At this point, I'd think more (potentially even redundant !) linking is better than too little 😄

@patrick-g-h patrick-g-h added closing soon issues that are about to be closed...speak up now! and removed closing soon issues that are about to be closed...speak up now! labels Jul 13, 2018
@patrick-g-h
Copy link
Collaborator

Okay edited! Tagging this now as closing soon to wait for any feedback in the next day or two before closing.

@patrick-g-h patrick-g-h added the closing soon issues that are about to be closed...speak up now! label Jul 13, 2018
@KirstieJane
Copy link
Member Author

Fine to close 👍🏻👍🏻

(I have some opinions about how to make those links to the wiki even clearer - the descriptions of what’s included could be actually linked to those pages in the wiki for example - but I’m happy for that to be something that we iterate on!)

🌟🌟🌟 Thanks @park-patrick & @emdupre!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
closing soon issues that are about to be closed...speak up now! community tasks relating to community development and support documentation tasks relating to improving our documentation enhancement requests to add something new to the project
Projects
None yet
Development

No branches or pull requests

3 participants