Document a part of your code

Documents a part of your code and checks the documentation against what the code really does.

Get started for free

What you ask

Search Acme

billing

2

  1. Nina

    @devboxes can you add a section to the README on how reminders get scheduled?

  2. devboxes APP

    #63 adds a "How reminders are scheduled" section to the README, from the first reminder through the grace period to the final notice, with links to the code.

    Opened #63

What devboxes does

  1. Read the module and its callers

    • devboxes notes how the module works, with references to the files.

  2. Write the docs

    • Everything the documentation says matches what the code does.

  3. Verify

    1. Install dependencies

    2. Test

    3. Lint

    4. If it fails

      1. Fix

        • The tests pass.

      2. Test again

      3. Lint again

  4. Publish

  5. Review

Good for

Startups

More tasks to ship from issues

Ask devboxes to document a part of your code

Get started for free