Create Dedicated Documentation?

[krowvin]

Speaking with @msweier about the documentation we both agreed it could be extended.

Mitch mentioned the public and their needs into it as well.

I'm aware this is a bit of an undertaking considering the API is still being worked on and added to.

But does a read-the-docs style website make sense? Or something more interactive for educational purposes as opposed to developer?

A site beyond the type declarations/javadoc that talks about actual usage and why you would want to use these endpoints comes to mind.

[krowvin]

@MikeNeilson this has come up more and more as we encourage districts and public members to use the existing and new endpoints.

Suggest we setup a larger meeting and/or iron out how to go about this. I know OpenDCS has a "QuickStart" guide.

Read the docs always comes to mind. But more enduser vs developer (Swagger)

[MikeNeilson]

Arguably we've had enough meetings and need to "just go". We originally talked about creating more user-interactive docs embedded into CDA itself using the groundwork framework.

However, that might make a somewhat circular dependency as that documentation should use CWMSjs which would lag.

So here are the options:

1. Read the docs
2. Embedded
3. Yet-another-repo that combines CWMSjs with the docs and we just host with github.io

[krowvin]

Update that we are leaning towards embedded and may also deploy to readthedocs.

Currently setting this up so the docs can live within the webapp itself next to the landing page here
Https://cwms-data.usace.army.mil/cwms-data

Work in progress: https://github.com/USACE/cwms-data-api/tree/817-dedicated-user-docs