Skip to content

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

Merged
merged 9 commits into from
Sep 25, 2023
Merged

Docs site improvements #132

merged 9 commits into from
Sep 25, 2023

Conversation

nrichers
Copy link
Collaborator

@nrichers nrichers commented Sep 21, 2023

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:

image

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):

image

Previous/Next topic footers for related topics that makes it easy to keep reading:

image

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):

image

Toggle key concepts section to expand by default and add some additional info for tests.

image

External Release Notes

We made a number of incremental improvements to our user guide:

  • 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 for each page that reflects the last time the source file was touched.
  • Previous and next topic footers** for related topics that make it easier to keep reading.
  • Lighter background for diagrams that improves legibility.
  • Expanded overview for key ValidMind concepts with some additional information.

@nrichers nrichers added documentation Improvements or additions to documentation internal Not to be externalized in the release notes labels Sep 21, 2023
@nrichers nrichers changed the title Notebook experiments Docs site experiments Sep 21, 2023
@nrichers nrichers changed the title Docs site experiments Docs site improvements Sep 22, 2023
@nrichers nrichers removed the internal Not to be externalized in the release notes label Sep 22, 2023
@nrichers
Copy link
Collaborator Author

I made an additional change to this PR: I toggled the section with key concepts to be expanded by default. It seems people are missing that we have this section and expanding it by default solves this (at the expense of a slightly longer getting started section).

image

@nrichers
Copy link
Collaborator Author

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.

@nrichers
Copy link
Collaborator Author

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 site/assets/bootstrap/js/bootstrap.min.js that gets loaded at the bottom of the HTML page we embed as our main docs landing page. Commenting out that JavaScript solves the issue.

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).

Output

On 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.

image

@nrichers nrichers merged commit f652805 into main Sep 25, 2023
@nrichers nrichers deleted the notebook-experiments branch September 25, 2023 22:24
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.

3 participants