getodk / getodk/docs

Edit Briefcase/Aggregate API page for clarity

Open
#459 0 comments 0 reactions 0 assignees View on GitHub
ODK
Dominant language
Python
Stars
58
Forks
160
Avg merge
5d 11h
Merged PRs (30d)
12

Description

briefcase-api.rst

The info here is good, and (seems) complete, but is hard to read and unclear. (More like a brain dump than a narrative.)

Part of #402

Contributor guide

Open the contributing guide

Research direction

Start by reading briefcase-api.rst and identify how its existing information is organized. Reshape the page into a clearer narrative while preserving the complete API information; done means the Briefcase/Aggregate API documentation is easier to read and understand.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.