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

Restructure for API only #146

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

JoelPasvolsky
Copy link
Contributor

This draft PR is just for feedback on the proposed structure, it won't be merged. The final PR will also need to update xrefs.
It enables local builds for testing, using the same theme as the SDK.

It (and most repos) would look like this in the SDK docs:

image

For simpler repos (dwave-inspector here), we can always have at least one page:

image

Or (penaltymodel here) we can either directly go to the API:

image

I like always having at least one underlying page for consistency and aesthetics but some people prefer one fewer click.
I can make draft PRs for the penaltymodel branch and dwave-inspector branch if that is helpful.
For now I'm taking advantage of GitHub's perfectly decent rendition of release notes but later if we want to spend the time working around reno's duplication of anchors between repos to prevent dozens of warnings, we can generate HTML for those again.

@arcondello arcondello self-requested a review January 29, 2025 19:14
@arcondello arcondello added documentation Improvements or additions to documentation enhancement New feature or request labels Jan 29, 2025
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 enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants