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

User Feedback + Make /type/<foo> and /routine/<foo> docs be a reference only #1646

Closed
zoffixznet opened this issue Nov 2, 2017 · 4 comments
Labels
big Issue consisting of many subissues docs Documentation issue (primary issue type) wishlist "nice to have" issues; might require a lot of work or a big change or be low priority

Comments

@zoffixznet
Copy link
Contributor

zoffixznet commented Nov 2, 2017

There was some feedback on the language and later more specific issues pointed out with the docs.

Some of the navigational issues will be resolved by the site's redesign to a dynamic version (to be done some time in first quarter of 2018). NOTE: It wasn't.

I too think that /type/* and /routine/* docs should be just reference material. They should describe all the details about routine's/Type's behaviour but should assume the reader already has some familiarity with the language and is just looking for edge-case details, list of all accepted arguments and return values, or a refresher material.

The /language/* docs on the other hand, should be more of beginner-aimed, tutorial-style docs where the language bits are explained in more general terms, along with examples and explanation of how all the pieces fit together. These docs would simply link to /type/*//routine/* as a "see for details" type of links, so that we don't repeat all the edge cases and all possible accepted arguments in /language/* docs.


(some of the more prominent bits quoted from OP:)

One thing I hit a lot is that the information I actually needed was spread over several documents, and it wasn't obvious at first which one I should hit.

I'd expect the Type documentation to be more man page-like, laying out a simple reference of each individual piece of functionality, which is what you get later in the Signatures doc in the "Methods" section. Basically, the entire "Signature Literal" sections should be removed from there and dropped into Functions.

As a more specific case, there doesn't seem to be a documented way to have a function's return type be an Array with the types inside further constrained (array of ints, for example). After some experimenting, I found that it's --> Array[Int], which might be what you expect if you used Moose on Perl5. It's not explicitly laid out anywhere I could find, though.

@zoffixznet zoffixznet added big Issue consisting of many subissues docs Documentation issue (primary issue type) labels Nov 2, 2017
@tisonkun
Copy link
Member

tisonkun commented Nov 3, 2017

Our /routine/* is not independent, they collect the doc from /language/* and /type/*. This should be resolved if we want to separate beginner parts from detailed parts.

I think to set a example how to rearrange the doc, we can start with Grammar, Grammar Tutorial and types relevant. Because to fix this issue, there should not be both Grammar and Grammar Tutorial in /language obviously, and Grammars are quite complete subset of the whole language, that is, we can refresh them while avoiding involve too many other parts

@tisonkun
Copy link
Member

tisonkun commented Nov 3, 2017

And after the discuss has achieved result, we should modify CONTRIBUTING.md and STYLEGUIDE.md to build a standard of what the doc need to be.

@JJ
Copy link
Contributor

JJ commented Apr 14, 2018

Those documents have changed a lot since this issue was written. /Language documents look more like tutorials, and the rest are more for reference. Can you please check that this has been addressed, and if it has not, propose some change?

@JJ JJ removed the JJ TPF Grant label May 14, 2018
@JJ JJ added the wishlist "nice to have" issues; might require a lot of work or a big change or be low priority label Jun 4, 2018
@JJ JJ added build labels Jan 2, 2019
@Altai-man
Copy link
Member

Altai-man commented Jul 14, 2020

Right now, we have just the structure described in OP, Language pages are tutorial-like and types/subs are man-like. Re-open if disagree.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
big Issue consisting of many subissues docs Documentation issue (primary issue type) wishlist "nice to have" issues; might require a lot of work or a big change or be low priority
Projects
None yet
Development

No branches or pull requests

4 participants