Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve contributor guide with respect to API documentation #1402

Open
sbenthall opened this issue Mar 28, 2024 · 0 comments
Open

Improve contributor guide with respect to API documentation #1402

sbenthall opened this issue Mar 28, 2024 · 0 comments

Comments

@sbenthall
Copy link
Contributor

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.

@sbenthall sbenthall added this to the 0.14.0 milestone Mar 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant