search

lanl / dsi

LANL Data Science Infrastructure Project
https://lanl.github.io/dsi
5 stars 4 forks source link

Usable documentation #6

Open qwofford opened 1 year ago

qwofford commented 1 year ago

We need to create some documentation at a higher level for people who only want to interface to DSI through its query capability. Existing documentation is more targeted at Driver, Plugin, and DSI core developers.

qwofford commented 1 year ago

Higher level documentation has been stubbed out in docs/quickstart.rst and docs/installation.

We should include quickstart and installation sections for both users who want to make queries, and Driver/Plugin contributors. All three types of DSI stakeholders should be addressed.

qwofford commented 1 year ago

Increasing scope of this issue. All documentation should be understandable, not just high level docs.