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

Writie initial Getting Started documentation #72

Closed
nickrobinson251 opened this issue Aug 2, 2019 · 5 comments
Closed

Writie initial Getting Started documentation #72

nickrobinson251 opened this issue Aug 2, 2019 · 5 comments
Labels
good first issue Good for newcomers

Comments

@nickrobinson251
Copy link
Contributor

We currently have some deployed docs at http://www.juliadiff.org/ChainRules.jl/latest/
crying out for "getting started" documentation.

Currently 4 sections are suggested

  • Forward-Mode vs. Reverse-Mode Chain Rule Evaluation
  • Real Scalar Differentiation Rules
  • Complex Scalar Differentiation Rules
  • Non-Scalar Differentiation Rules
    ...but some other categorisation might work fine.

Adding even one section would be a great start.

Lots of things have docstrings now... but adding more would also be helpful!

@aman-bhu
Copy link

aman-bhu commented Aug 4, 2019

Hey, I want to contribute, can you help me how to get started?

@oxinabox
Copy link
Member

oxinabox commented Aug 4, 2019

Some links which should be read to form basic of this getting started documentation:

@oxinabox
Copy link
Member

oxinabox commented Sep 5, 2019

Probably not a good first issue

@nickrobinson251
Copy link
Contributor Author

🤷 trying to write some documentation was how I got started with the package

@oxinabox
Copy link
Member

Closed by #103

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants