econ-ark / HARK

Heterogenous Agents Resources & toolKit
Apache License 2.0
315 stars 195 forks source link

Improve contributor guide with respect to API documentation #1402

Open sbenthall opened 1 month ago

sbenthall commented 1 month ago

It occurs to me based on a recent exchange that we haven't really laid out a good procedure for reviewing documentation changes on new PRs.

Which might explain why our docs are in the state they are in.

This part of the contribution guide is incomplete, since it doesn't describe how to add new files/modules to the API docs, or test the documentation build: https://docs.econ-ark.org/guides/contributing.html#documentation-convention

That could be added.