getodk / getodk/web-forms

Client interface documentation

Open
#64 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
38
Forks
22
PR merge metrics
No merged PRs in 30d

Description

Related to the engine/client interface work serving (#45 and the fuller design coming from that), we would benefit from clear/browsable documentation of the interface. [TypeDoc](https://typedoc.org/) is probably a good starting point (and it's incorporated in my client implementation working branch). We should also clarify as part of the README that this (at least) is a specific area of documentation we consider a user-facing requirement/deliverable with ongoing maintenance expectations[^1].

[^1]: Even if that maintenance is just ensuring doc generation works and continues to meet our expectations when generated.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing the engine/client interface work in #45 and the fuller design referenced there, then inspect the client implementation working branch and existing README. Evaluate TypeDoc as the documentation approach for the interface and document the user-facing requirement and maintenance expectations in the README. Done when the interface documentation is browsable and its generation remains maintainable.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.