-
Notifications
You must be signed in to change notification settings - Fork 451
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
Docs for the docs #1197
Docs for the docs #1197
Conversation
I'd love to get some eyes mostly in the section about snippet policies on when to go for Dokka inlined docs, runnable snippets, and other stuff. Let me know if it's clear and whether it's in the line of what we want to do with snippets @raulraja. |
``` | ||
|
||
Again, take a look at [this PR](https://github.com/arrow-kt/arrow/pull/1134/files) for a real example. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would add a section here that there needs to be a small description and a link from the datatype or typeclass intro pages back to the doc, so people can scan them easily in a single page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Makes sense. Added now 👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Excellent and much needed, thanks
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To p'alanteeeerl
Follow up to #1139 which was a very good start for the
Ank
docs.Fixes #1195