Giter Club home page Giter Club logo

docathon's Introduction

The docathon

Everybody knows how important documentation is. It lets new users learn the contents of a package quickly, it lets current users quickly answer questions they have about a package, it also often gives examples of the "best" or "proper" ways to use a package.

However, as important as it is, we often don't give documentation enough attention. Docstrings are incomplete or missing argument explanations, examples don't compile or reveal outdated APIs, tutorials are often idiosynchratic (or not even there).

We think documentation is great, so we're devoting a week to improving the documentation in the open-source ecosystem. We're going to call it "the docathon".

For more information about the docathon, check out the website here

What is a docathon

It's kind of like a hackathon, but focused on developing material and tools for documentation. This is the first of hopefully many docathons to come!

When is the docathon?

The first docathon will be tentatively held in early 2017, more details to come!

Where is the docathon?

We'll have one meeting at the beginning of the week to discuss potential projects and pair interested helpers with packages / projects that need work. We'll have a physical presence at the Berkeley Institute for Data Science, but all are welcome to participate in person or remotely.

What are you planning to do?

As a group, we'll spend the week working on various projects that aim to improve the documentation in our open-source ecosystem. This might be improving the docstrings of a function, or upgrading examples to using a new docs technology, or even building infrastructure and tools for improving documentation.

How can I get involved?

Check back here soon for a form that we'll use to field ideas for projects and organize people to work on them!

Projects that may be interested

  • matplotlib (see with NelleV)
  • scikit-learn
  • mne

docathon's People

Contributors

choldgraf avatar nellev avatar carreau avatar

Watchers

 avatar James Cloos avatar  avatar

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.