Giter VIP home page Giter VIP logo

Comments (3)

janosg avatar janosg commented on June 30, 2024 2

If you are thinking about a general re-organization of the documentation, I would like to suggest this system which I found very helpful in my own projects. It groups documentation in four categories:

  • Reference: This is helpful for experienced users who want to look up a specific syntax. The current documentation is almost exclusively written in reference style (auto-generated from docstrings)
  • Explanation: This is helpful for people who want to learn the economics/numerics and syntax at the same time. This is the style of the quantecon lectures.
  • Tutorials: Tutorials help newbies to discover the functionality of a package. In my experience, tutorials can increase the adoption of a package. The submitted paper is written in tutorial style, Having a notebook with all examples from the paper would be a great getting started tutorial.
  • How-To Guides: How-To Guides show how to achieve a very specific task without explaining any background that is not immediately relevant. I think this is not covered in the current documentation.

A great example of documentation that uses this system is pytask

from quantecon.py.

jstac avatar jstac commented on June 30, 2024

+1

from quantecon.py.

mmcky avatar mmcky commented on June 30, 2024

thanks @janosg -- nice suggestion.

from quantecon.py.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.