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

Add philosophy section to the docs #208

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

arcondello
Copy link
Member

No description provided.

@arcondello arcondello added the documentation Improvements or additions to documentation label Jan 17, 2025
@arcondello arcondello changed the title Add philosophy section to the docs as well as navigation Add philosophy section to the docs Jan 17, 2025
Copy link
Contributor

@JoelPasvolsky JoelPasvolsky left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is good. My only thoughts so far are these:

  1. A less generic header instead of "Features". Perhaps "Design Principals"?
  2. an explicit link to the new page; for example, "dwave-optimization and the hybrid nonlinear solver incorporate features and :ref:design principals <optimization_philosophy> from each of the following areas:"
  3. In the context of a description, the text in the boxes should be descriptive too (e.g., "Exploiting quantum-mechanical effects not available to classical compute" and "Solving optimization problems with linear program solvers")

@arcondello
Copy link
Member Author

Agree with the first two. For (3) it's a box we want people to click, so IMO the imperative makes that clearer.

@JoelPasvolsky
Copy link
Contributor

JoelPasvolsky commented Jan 24, 2025

Agree with the first two. For (3) it's a box we want people to click, so IMO the imperative makes that clearer.

I wouldn't understand it that way, if I see "Learn the basics of solving optimization problems with linear program solvers" I'd expect that clicking would move me away from learning about dwave-optimization to some LP tutorial. As a new user, I'm here to learn to use the NL solver. Perhaps we can use an icon or something to clarify that clicking will take them to a knowledge resource on the underlying design ideas.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants