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

Mention stdlib docs, or lack thereof #2783

Closed
wants to merge 3 commits into from
Closed

Conversation

Tetralux
Copy link
Contributor

Also points out that the documentation in the downloads section also functions as the quick reference guide.

I can remove that if preferred though.

I can remove the change to the `Resources` section if preferred.
@hryx
Copy link
Contributor

hryx commented Jun 28, 2019

This question comes up multiple times a week, so thanks for addressing it. But there are problems with this:

  • The README is meant as a quickstart guide. (This was mentioned in another issue, but I can't find it.) This belongs in the wiki. I've been meaning to add this as an FAQ there, and looks like it's high time.
  • stdlib documentation is planned for before 1.0. The ticket is generate html documentation for a library #21, which has milestone set to 0.5. The 1.0 release is far off still, so this may unnecessarily discourage people.

@hryx
Copy link
Contributor

hryx commented Jun 28, 2019

@Tetralux
Copy link
Contributor Author

@hryx
It wouldn't immediately occur to me to search the wiki, so I'd suggest having a reminder in the readme that mentions it. Maybe that's just me.
But yes - other than that sounds good to me.

@hryx
Copy link
Contributor

hryx commented Jun 29, 2019

It wouldn't immediately occur to me to search the wiki

That's totally fair. Presumably the new FAQ will be search engine-friendly, but who knows. Maybe we should link to the FAQ in the "Resources" section? 🤷‍♀

Tetralux and others added 2 commits June 29, 2019 18:41
Co-Authored-By: Komu Wairagu <[email protected]>
@andrewrk
Copy link
Member

andrewrk commented Jul 2, 2019

Thanks for the PR. I took care of this in 04b32d6. So now the standard library docs FAQ can be discovered by going to README -> FAQ or by going to Documentation -> master -> Introduction

@andrewrk andrewrk closed this Jul 2, 2019
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.

4 participants