-
Notifications
You must be signed in to change notification settings - Fork 4
Docs site improvements #132
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
Conversation
During testing, I noticed that the CSS on the front page of our docs site interferes with the new "Developer Framework" drop-down. Need to investigate and fix before merging this PR. |
I traced this issue back to the Bootstrap JavaScript in Looking at the code, it's possible that the embed of Popper JavaScript in that file is the cause, but I don't want to start modifying Bootstrap JavaScript code itself. This looks to be a case of overlapping functionality — dropdowns and tooltips we get from Quarto are also defined via Bootstrap and they interfere. With the Bootstrap JavaScript disabled, I did some testing to make sure the page is still reactive (it is) and that it works in Chrome, Safari, and FireFox (it does). OutputOn the left is the current home page with JavaScript enabled, right is this pull request with JavaScript disabled running on localhost. They are near identical. |
Internal Notes for Reviewers
This PR includes a number of incremental improvements for our docs site that came out of notebook testing in preparation for the closed beta. If this looks good to you, please approve and I will publish.
New dropdown for the Developer Framework that gives faster access to the most important bits, such as our code samples and the reference documentation:
Publication date info for each page that reflects the last time the source file was touched (intially, all files will show that they have been updates as they now all include
last-modified
but subsequent releases will make it much easier to see what was updated):Previous/Next topic footers for related topics that makes it easy to keep reading:
Mermaid diagrams now use a lighter color to improve legibility, picked from the ValidMind palette (previously, they used a much darker pink which feels glaring after a while):
Toggle key concepts section to expand by default and add some additional info for tests.
External Release Notes
We made a number of incremental improvements to our user guide: