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

Docs for the docs #1197

Merged
merged 8 commits into from
Dec 13, 2018
Merged

Conversation

JorgeCastilloPrz
Copy link
Member

@JorgeCastilloPrz JorgeCastilloPrz commented Dec 13, 2018

Follow up to #1139 which was a very good start for the Ank docs.

Fixes #1195

  • Add how to contribute section including all required details
  • Add docs structure summary to help people having a mental map
  • Added formatting guidelines
  • Add prioritized policies on how to add snippets
  • Add how to deploy Ank to a local server to test your changes

@JorgeCastilloPrz
Copy link
Member Author

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.

Copy link
Member

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.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense. Added now 👍

Copy link
Member

@raulraja raulraja left a 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

Copy link
Member

@pakoito pakoito left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To p'alanteeeerl

@JorgeCastilloPrz JorgeCastilloPrz merged commit 44cb9b1 into master Dec 13, 2018
@JorgeCastilloPrz JorgeCastilloPrz deleted the 1195-jc-arrow-docs-contribution-docs branch December 13, 2018 14:34
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