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

Docs don't introduce the idea of "models" #910

Closed
jamesrhester opened this issue Aug 26, 2021 · 3 comments · Fixed by #912
Closed

Docs don't introduce the idea of "models" #910

jamesrhester opened this issue Aug 26, 2021 · 3 comments · Fixed by #912
Labels
docs Issues pertaining to documentation. joss Issues pertaining to the JOSS review of this repository.

Comments

@jamesrhester
Copy link

(Part of JOSS review)

The documentation contains a top-level entry "all models", but the significance or meaning of a "model" is not described anywhere I could find. A suitable place for this description might be either in "getting started", or perhaps a new top level entry with a brief introduction for developers, if this is developer-specific.

@ml-evs
Copy link
Member

ml-evs commented Aug 26, 2021

Thanks again @jamesrhester, I am addressing this in #912. For now, I have made the "all models" page clearer with a more descriptive link in the README. I think it also makes sense to add some examples under "getting started" as you suggest, I will do this in a separate PR.

@ml-evs
Copy link
Member

ml-evs commented Aug 26, 2021

I should just add that any changes we make to the documentation will not be reflected online at https://optimade.org/optimade-python-tools until we make a release.

@jamesrhester
Copy link
Author

jamesrhester commented Aug 27, 2021

Thanks, looks good. Just calling them "data models" cleared it up for me.

@ml-evs ml-evs added docs Issues pertaining to documentation. joss Issues pertaining to the JOSS review of this repository. labels Sep 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Issues pertaining to documentation. joss Issues pertaining to the JOSS review of this repository.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants