Request for Additional Documentation

[hunhoffe]

Is your feature request related to a problem? Please describe.

I'd like a few things added to the reference documentation.

In particular, DCM is especially useful for those who want to solve a hard problem but aren't using to working with a solver directly. Some context on recommended design principles and performance & scalability of various solver operations would be helpful to first time users.

Describe the solution you'd like

Some ideas of various levels of concreteness:

• The reference documentation here should be linked to in the "Documentation" section on the main README page.
• Include an example of weighted constraints in the reference, or in a "simple examples" document (e.g., sometimes it's nice to see snippets rather than have to go through an entire loadbalancer example or similar to see a common use case)
• Add a "Design Principles to Keep in Mind" section to the reference or other document
• Maybe add a scalability/performance section so we can have some idea of what we can expect from DCM.

Describe alternatives you've considered

Ask questions via github issues! 😄

Additional context

No response

[lalithsuresh]

Thanks for the concrete suggestions! I'll start adding some content to the docs.