Skip to content

Conversation

@nrichers
Copy link
Collaborator

@nrichers nrichers commented Sep 19, 2025

Pull Request Description

THIS PR NEEDS FURTHER TESTING AND CHANGES BEFORE WE CAN MERGE

What and why?

In this PR:

  • Footer and navigation dropdown — Added API reference links to Public REST API and Python API
  • Footer layout — Reduced the "Guides" section from three to two columns and reshuffled content
  • Refactor CSS — Moved footer-specific styles into a dedicated _footer.scss file for better maintainability

Notes:

  • Navbar CSS: I did not modify the navbar CSS because some class names closely resemble those used for the sidebar. To keep the refactor simple and safe, I focused only on the footer.
  • Footer layout changes: Adding the Public REST API link to the “Library” section makes that column noticeably taller than the others. Reducing the “Guides” columns from three to two creates a more balanced layout and lowers the minimum window width required to display the full footer.

Relates to sc-12329; blocked by #949

How to test

Take a look at the preview or compare the screenshots: LIVE PREVIEW

Before

Capto_ 2025-09-19_11-09-20_am

After

Capto_ 2025-09-19_11-12-22_am

What needs special review?

Dependencies, breaking changes, and deployment notes

Release notes

Checklist

  • What and why
  • Screenshots or videos (Frontend)
  • How to test
  • What needs special review
  • Dependencies, breaking changes, and deployment notes
  • Labels applied
  • PR linked to Shortcut
  • Unit tests added (Backend)
  • Tested locally
  • Documentation updated (if required)
  • Environment variable additions/changes documented (if required)

@nrichers nrichers added the internal Not to be externalized in the release notes label Sep 19, 2025
@nrichers nrichers changed the title Nrichers/sc 12329/add public api to footer Improve navigation for APIs Sep 19, 2025
@nrichers nrichers changed the title Improve navigation for APIs Improve navigation for Python API and Public REST API Sep 19, 2025
@nrichers nrichers requested a review from validbeck September 19, 2025 19:27
@validbeck
Copy link
Collaborator

Going to take a closer look, but I don't like this:

Footer layout — Reduced the "Guides" section from three to two columns and reshuffled content

I massaged the footer into the three columns initially because the two columns looked un-equal and cramped. Can we please revert? Your columns are actually also missing a link! (Access)

@nrichers
Copy link
Collaborator Author

nrichers commented Sep 19, 2025

I massaged the footer into the three columns initially because the two columns looked un-equal and cramped. Can we please revert? Your columns are actually also missing a link! (Access)

As discussed, I re-added the "Access" link and balanced the links across the columns.

FYI, there are some column spacing issues, I have a CSS fix in the works that gets them looking like this and wraps correctly, will tag you for re-review when I have completed testing:

image

@validbeck
Copy link
Collaborator

FYI, there are some column spacing issues, I have a CSS fix in the works that gets them looking like this and wraps correctly, will tag you for re-review when I have completed testing:

The top and bottom padding seems a little squished as well, I tried to poke around in it but admittedly I haven't spent much time with the footer so I'm not sure if I'm looking in the right place... 🤔

@validbeck
Copy link
Collaborator

@nrichers I think the last CSS PR mucked up the link styling as well . . .

Old (correct) New (what's currently on main
Screenshot 2025-09-22 at 9 38 03 AM Screenshot 2025-09-22 at 9 38 10 AM

Can you please look into a fix in this PR?

@nrichers
Copy link
Collaborator Author

nrichers commented Sep 22, 2025

I think the last CSS PR mucked up the link styling as well . . .

Yes, I will take a look. It's possible I actually looked at the related CSS as part of the footer testing.

(Currently in product feature description hell but will take a look as soon as I can!)

EDIT: the CSS I looked at was unrelated, ignore.

@nrichers
Copy link
Collaborator Author

The top and bottom padding seems a little squished as well, I tried to poke around in it but admittedly I haven't spent much time with the footer so I'm not sure if I'm looking in the right place... 🤔

I would hold off on poking around; I'm four hours deep into the footer CSS. Might be easier for you to just review my changes when they are ready.

@nrichers
Copy link
Collaborator Author

@nrichers I think the last CSS PR mucked up the link styling as well . . .

@validbeck I figured it out in b8d5127:

  • styles.css overrides themes.scss; we've basically been using it as a big hammer to override the Quarto theme
  • We had a definition for links in themes.scss that set it to $link-color: $body-color; which happens to be the color you're now seeing
  • With the CSS for links moved into _links.scss, the definition in themes.scss took precedence. I was able to verify this in the dev tools in my browser

The fix is to set the link color the way Quarto intended and not to immediately resort to overriding the theme.

But note is some other CSS affected, will take a look when I have a chance:

Capto_ 2025-09-22_11-24-54_am

@nrichers
Copy link
Collaborator Author

OK, many hours later ...

  • Footer display should be fixed on desktop, responsive, and mobile views for the most part (see below).
  • The main themes.css now imports only other SCSS files, cleaning up where we define our SCSS styles. (The import order matters, FYI.)
  • Many colors are now defined once in _validmind_colors.scss and reused as variables elsewhere.
  • New SCSS files continue the process of pulling CSS out of styles.css and moving existing SCSS into better locations (examples: _dropdowns.scss for dropdown menus; _footer.scss now contains all footer definitions instead of defining footer links in _links.scss).
  • Some duplicated CSS made testing time consuming. I’ve removed what I found, but more cleanup is to come.

Overall, other than the footer fixes, the CSS should behave as before, but I would welcome some independent review to make sure I have not missing something. I'm at the 'not seeing the forest for all the trees' stage with this PR and I'm tired testing. 🌲🌲🌲

Footer display

Desktop mode (1440x900)

image

Responsive mode

Starting to wrap:

image

The most we will wrap before hiding the links:

image

Issue: I would prefer not to wrap the links section (.nav-footer-center) into more than two rows before hiding. I tried several methods, but there continues to be a conflict between our styles and Bootstrap. For now, I’ve left it at improving the specificity of our footer styles. Other attempts that made no difference include:

  • Using even stronger specificity and more comprehensive hiding rules
  • Applying specific Bootstrap override instructions (@layer bootstrap-override)

If you have some clever ideas, I'd love to hear about them. For now, I am out of time on investigating this further.

Small screens:

image

Mobile mode

image

@nrichers
Copy link
Collaborator Author

@validbeck one other thing before I re-request review from you: there are some specificity differences when you use SCSS versus styles.css. My take is that some differences are OK, but if there are notable ones you think we should fix, let me know (as I am sure you will!).

@nrichers nrichers requested a review from validbeck September 25, 2025 02:01
Copy link
Collaborator

@validbeck validbeck left a comment

Choose a reason for hiding this comment

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

The links still don't quite look right on hover:

OLD CURRENT
Screenshot 2025-09-25 at 11 39 03 AM Screenshot 2025-09-25 at 11 39 16 AM

In this case I personally like the new non-underlined link better, but having an underline somewhere in the link interaction process is a good accessibility tool . . .

Footer has all the stuff (I think) but the top and bottom padding is still really squished. For example:

OLD CURRENT
Screenshot 2025-09-25 at 11 37 45 AM Screenshot 2025-09-25 at 11 41 18 AM

I tried playing around with it locally but nothing I did to the padding seems to have adjusted anything, so I'm not sure how that's all working.

@nrichers
Copy link
Collaborator Author

Footer has all the stuff (I think) but the top and bottom padding is still really squished.

This is fixed in 0b1007d:

image

The links still don't quite look right on hover

This should be fixed in 78b5e8c and 175c4e8:

Capto_.2025-09-26_10-40-18_am.mov

With all of these issues, the correct approach that gives most fine-grained control seems to be:

  • Find the right CSS selector, the more specific the better
  • Search for any duplicated CSS that might be causing the issue and resolve
  • Determine if it should be a SCSS default that overrides Bootstrap or a SCSS rule (note SCSS defaults MUST live in themes.scss, fixed in 20e1f5c)
  • If our styles still get overriden by Bootstrap, typically because they are a rule and not a default, selectively apply !important

@github-actions
Copy link
Contributor

PR Summary

This PR introduces extensive refinements to the styling and theme configuration of the website. The changes unify color usage by replacing hard-coded color values with Sass variables (e.g., for buttons, navbar, sidebar, code blocks, and other elements) to promote consistency with the ValidMind brand.

Key changes include:

  • Updates to navigation elements in the Quarto configuration (_quarto.yml), such as replacing icon-based text with plain text labels and adding new links (e.g., Python API and Public REST API).
  • Modifications to the .gitignore file to include new file patterns (e.g., Quarto notebooks) to ensure unwanted files are ignored.
  • Addition of new SCSS files, particularly for dropdown menus and improvements to the footer, navbar, sidebar, TOC, and mermaid diagram styles. These changes streamline the styling, responsiveness, and overall look and feel of the site.
  • Cleanup of legacy CSS in the site/styles.css file to avoid conflicts with the new SCSS-based styling.
  • Minor textual updates in the developer documentation (testing-overview.qmd) to correctly refer to the 'Python API Reference'.

The functional changes are strictly related to presentation and navigation improvements, without affecting underlying business or application logic.

Test Suggestions

  • Perform visual regression tests across different pages (navbar, footer, sidebar, TOC, code blocks, dropdown menus) to verify all UI elements are displaying as expected.
  • Verify that all navigation links (including new Python API and Public REST API links) are correct and functional.
  • Test the responsiveness of the site on various screen sizes and devices to confirm that layout changes (e.g., SCSS media queries) work as intended.
  • Ensure that the SCSS compilation process works without errors after the changes.
  • Check that file ignore patterns in .gitignore appropriately exclude the specified files.

@github-actions
Copy link
Contributor

Vale source linter

⚠️ WARN: Found 14198 issues across 683 files — Check the workflow run or download the full report

Show first 30 files with issues

site/404.qmd

  • Line 2: Use parentheses judiciously. (suggestion)
  • Line 3: Did you really mean 'html'? (error)
  • Line 53: Did you really mean 'const'? (error)
  • Line 53: Use parentheses judiciously. (suggestion)
  • Line 54: Did you really mean 'const'? (error)
  • Line 54: Did you really mean 'ctx'? (error)
  • Line 54: Use parentheses judiciously. (suggestion)
  • Line 54: Put a nonbreaking space between the number and the unit in '2d'. (error)
  • Line 58: Did you really mean 'const'? (error)
  • Line 58: Did you really mean 'fontSize'? (error)
  • ... and 23 more issues

site/about/contributing/style-guide/conventions.qmd

  • Line 6: Use 'it's' instead of 'it is'. (suggestion)
  • Line 6: In general, use active voice instead of passive voice ('is received'). (suggestion)
  • Line 6: Use parentheses judiciously. (suggestion)
  • Line 9: Use 'capability' or 'feature' instead of 'functionality'. (warning)
  • Line 9: Use 'shouldn't' instead of 'should not'. (suggestion)
  • Line 9: In general, use active voice instead of passive voice ('be lost'). (suggestion)
  • Line 15: Did you really mean 'Palo'? (error)
  • Line 19: Avoid using 'will'. (warning)
  • Line 19: In general, use American spelling instead of 'centre'. (warning)
  • Line 19: Avoid using 'will'. (warning)
  • ... and 180 more issues

site/about/contributing/style-guide/style-guide.qmd

  • Line 2: Spell out 'USING', if it's unfamiliar to the audience. (suggestion)
  • Line 2: Spell out 'THE', if it's unfamiliar to the audience. (suggestion)
  • Line 2: Spell out 'THE', if it's unfamiliar to the audience. (suggestion)
  • Line 2: Spell out 'TITLE', if it's unfamiliar to the audience. (suggestion)
  • Line 2: Spell out 'THE', if it's unfamiliar to the audience. (suggestion)
  • Line 22: Try to avoid using first-person plural like 'we'. (warning)
  • Line 22: Try to avoid using first-person plural like 'we'. (warning)
  • Line 22: Try to avoid using first-person plural like 'We'. (warning)
  • Line 24: Try to avoid using first-person plural like 'Our'. (warning)
  • Line 24: Try to avoid using first-person plural like 'our'. (warning)
  • ... and 13 more issues

site/about/contributing/style-guide/voice-and-tone.qmd

  • Line 6: Try to avoid using first-person plural like 'we'. (warning)
  • Line 8: Try to avoid using first-person plural like 'we'. (warning)
  • Line 8: Try to avoid using first-person plural like 'our'. (warning)
  • Line 8: Try to avoid using first-person plural like 'we'. (warning)
  • Line 8: Try to avoid using first-person plural like 'we'. (warning)
  • Line 18: Avoid using 'will'. (warning)
  • Line 18: In general, use active voice instead of passive voice ('be reviewed'). (suggestion)
  • Line 22: Use parentheses judiciously. (suggestion)
  • Line 22: Try to avoid using first-person plural like 'we'. (warning)
  • Line 22: Don't put a space before or after a dash. (error)
  • ... and 39 more issues

site/about/contributing/validmind-community.qmd

  • Line 8: Use parentheses judiciously. (suggestion)
  • Line 8: Spell out 'MRM', if it's unfamiliar to the audience. (suggestion)
  • Line 8: Try to avoid using first-person plural like 'our'. (warning)
  • Line 8: Don't use exclamation points in text. (error)
  • Line 8: Try to avoid using first-person plural like 'us'. (warning)
  • Line 14: Try to avoid using first-person plural like 'our'. (warning)
  • Line 19: Don't use exclamation points in text. (error)
  • Line 25: Use parentheses judiciously. (suggestion)
  • Line 31: Try to avoid using first-person plural like 'our'. (warning)
  • Line 42: Use parentheses judiciously. (suggestion)
  • ... and 37 more issues

site/about/deployment/_deployment-available-options.qmd

  • Line 1: Try to avoid using first-person plural like 'Our'. (warning)
  • Line 1: Use parentheses judiciously. (suggestion)
  • Line 1: Use 'Google Cloud Platform' or 'GCP' instead of 'Cloud'. (warning)
  • Line 3: Try to avoid using first-person plural like 'We'. (warning)
  • Line 5: Don't put a space before or after a dash. (error)
  • Line 5: Use parentheses judiciously. (suggestion)
  • Line 5: In general, use active voice instead of passive voice ('be established'). (suggestion)
  • Line 7: Use parentheses judiciously. (suggestion)
  • Line 7: Spell out 'VPV', if it's unfamiliar to the audience. (suggestion)
  • Line 7: Don't put a space before or after a dash. (error)
  • ... and 1 more issues

site/about/deployment/deployment-options.qmd

  • Line 24: Use parentheses judiciously. (suggestion)
  • Line 26: Use 'Google Cloud Platform' or 'GCP' instead of 'Cloud'. (warning)
  • Line 28: Try to avoid using first-person plural like 'our'. (warning)
  • Line 32: Don't put a space before or after a dash. (error)
  • Line 32: Did you really mean 'validators'? (error)
  • Line 34: Don't put a space before or after a dash. (error)
  • Line 36: Don't put a space before or after a dash. (error)
  • Line 38: Don't put a space before or after a dash. (error)
  • Line 42: Try to avoid using first-person plural like 'We'. (warning)
  • Line 42: Use 'data is' instead of 'data are'. (warning)
  • ... and 12 more issues

site/about/deployment/multi-tenant-cloud.qmd

  • Line 13: Use 'tap' instead of 'touch'. (warning)
  • Line 17: Did you really mean 'deployment_'? (error)
  • Line 19: Use 'it's' instead of 'it is'. (suggestion)
  • Line 21: Use parentheses judiciously. (suggestion)
  • Line 29: Don't put a space before or after a dash. (error)
  • Line 30: Don't put a space before or after a dash. (error)
  • Line 31: Don't put a space before or after a dash. (error)
  • Line 32: Don't put a space before or after a dash. (error)
  • Line 39: In general, use active voice instead of passive voice ('is encrypted'). (suggestion)
  • Line 40: Use parentheses judiciously. (suggestion)
  • ... and 2 more issues

site/about/deployment/virtual-private-validmind.qmd

  • Line 2: Spell out 'USING', if it's unfamiliar to the audience. (suggestion)
  • Line 2: Spell out 'THE', if it's unfamiliar to the audience. (suggestion)
  • Line 2: Spell out 'THE', if it's unfamiliar to the audience. (suggestion)
  • Line 2: Spell out 'TITLE', if it's unfamiliar to the audience. (suggestion)
  • Line 2: Spell out 'THE', if it's unfamiliar to the audience. (suggestion)
  • Line 3: Use parentheses judiciously. (suggestion)
  • Line 3: Spell out 'VPV', if it's unfamiliar to the audience. (suggestion)
  • Line 14: Use 'tap' instead of 'touch'. (warning)
  • Line 18: Use parentheses judiciously. (suggestion)
  • Line 18: Spell out 'VPV', if it's unfamiliar to the audience. (suggestion)
  • ... and 8 more issues

site/about/fine-print/data-privacy-policy.qmd

  • Line 12: Try to avoid using first-person plural like 'our'. (warning)
  • Line 19: Try to avoid using first-person plural like 'we'. (warning)
  • Line 21: Try to avoid using first-person plural like 'Our'. (warning)
  • Line 21: Try to avoid using first-person plural like 'our'. (warning)
  • Line 21: Try to avoid using first-person plural like 'our'. (warning)
  • Line 26: Try to avoid using first-person plural like 'our'. (warning)
  • Line 26: Try to avoid using first-person plural like 'we'. (warning)
  • Line 26: Try to avoid using first-person plural like 'our'. (warning)
  • Line 34: Use 'what's' instead of 'What is'. (suggestion)
  • Line 36: Try to avoid using first-person plural like 'our'. (warning)
  • ... and 49 more issues

site/about/fine-print/license-agreement.qmd

  • Line 9: Spell out 'READ', if it's unfamiliar to the audience. (suggestion)
  • Line 9: Spell out 'THIS', if it's unfamiliar to the audience. (suggestion)
  • Line 9: Use parentheses judiciously. (suggestion)
  • Line 9: Spell out 'THIS', if it's unfamiliar to the audience. (suggestion)
  • Line 9: Spell out 'USING', if it's unfamiliar to the audience. (suggestion)
  • Line 9: Spell out 'THE', if it's unfamiliar to the audience. (suggestion)
  • Line 9: Spell out 'USING', if it's unfamiliar to the audience. (suggestion)
  • Line 9: Spell out 'THE', if it's unfamiliar to the audience. (suggestion)
  • Line 9: Spell out 'YOU', if it's unfamiliar to the audience. (suggestion)
  • Line 9: Spell out 'ARE', if it's unfamiliar to the audience. (suggestion)
  • ... and 115 more issues

site/about/glossary/_ai.qmd

  • Line 1: Spell out 'IBM', if it's unfamiliar to the audience. (suggestion)
  • Line 1: Use parentheses judiciously. (suggestion)
  • Line 3: Use parentheses judiciously. (suggestion)
  • Line 7: Use parentheses judiciously. (suggestion)
  • Line 9: Use parentheses judiciously. (suggestion)
  • Line 10: In general, use active voice instead of passive voice ('were trained'). (suggestion)
  • Line 12: Use parentheses judiciously. (suggestion)
  • Line 12: Spell out 'LLM', if it's unfamiliar to the audience. (suggestion)
  • Line 13: Use parentheses judiciously. (suggestion)

site/about/glossary/_attestation.qmd

  • Line 2: Did you really mean 'validator'? (error)
  • Line 2: In general, use active voice instead of passive voice ('are met'). (suggestion)
  • Line 5: In general, use active voice instead of passive voice ('is triggered'). (suggestion)
  • Line 14: Did you really mean 'validators'? (error)

site/about/glossary/_developer-tools.qmd

  • Line 2: Use parentheses judiciously. (suggestion)
  • Line 2: Use 'capability' or 'feature' instead of 'functionality'. (warning)
  • Line 15: Use 'that's' instead of 'that is'. (suggestion)
  • Line 20: Try to avoid using first-person plural like 'our'. (warning)
  • Line 30: Use parentheses judiciously. (suggestion)
  • Line 32: Use parentheses judiciously. (suggestion)

site/about/glossary/_model-documentation.qmd

  • Line 1: Spell out 'MODEL', if it's unfamiliar to the audience. (suggestion)
  • Line 1: Spell out 'NEEDS', if it's unfamiliar to the audience. (suggestion)
  • Line 1: In general, use active voice instead of passive voice ('BE ADDED'). (suggestion)
  • Line 1: Spell out 'ADDED', if it's unfamiliar to the audience. (suggestion)
  • Line 3: Use parentheses judiciously. (suggestion)
  • Line 4: Spell out 'ABC', if it's unfamiliar to the audience. (suggestion)

site/about/glossary/_models.qmd

  • Line 4: Use parentheses judiciously. (suggestion)
  • Line 7: In general, use active voice instead of passive voice ('are derived'). (suggestion)
  • Line 7: In general, use active voice instead of passive voice ('is achieved'). (suggestion)
  • Line 11: Use parentheses judiciously. (suggestion)
  • Line 15: Use 'it's' instead of 'it is'. (suggestion)
  • Line 15: In general, use active voice instead of passive voice ('is decommissioned'). (suggestion)
  • Line 15: Use parentheses judiciously. (suggestion)
  • Line 22: Use parentheses judiciously. (suggestion)
  • Line 22: Spell out 'MRM', if it's unfamiliar to the audience. (suggestion)
  • Line 23: In general, use active voice instead of passive voice ('are developed'). (suggestion)

site/about/glossary/_monitoring.qmd

  • Line 1: Spell out 'NEEDS', if it's unfamiliar to the audience. (suggestion)
  • Line 1: In general, use active voice instead of passive voice ('BE ADDED'). (suggestion)
  • Line 1: Spell out 'ADDED', if it's unfamiliar to the audience. (suggestion)
  • Line 3: Use parentheses judiciously. (suggestion)
  • Line 4: Spell out 'ABC', if it's unfamiliar to the audience. (suggestion)

site/about/glossary/_mrm.qmd

  • Line 3: Put a nonbreaking space between the number and the unit in '1s'. (error)
  • Line 3: Spell out all ordinal numbers ('1st') in text. (error)
  • Line 4: Don't use plurals in parentheses such as in 'unit(s)'. (error)
  • Line 4: Use parentheses judiciously. (suggestion)
  • Line 4: Put a nonbreaking space between the number and the unit in '1s'. (error)
  • Line 4: Spell out all ordinal numbers ('1st') in text. (error)
  • Line 4: Use 'they're' instead of 'they are'. (suggestion)
  • Line 6: Spell out all ordinal numbers ('2nd') in text. (error)
  • Line 7: Spell out all ordinal numbers ('2nd') in text. (error)
  • Line 7: Did you really mean 'validators'? (error)
  • ... and 11 more issues

site/about/glossary/_validation-reports.qmd

  • Line 1: Spell out 'NEEDS', if it's unfamiliar to the audience. (suggestion)
  • Line 1: In general, use active voice instead of passive voice ('BE ADDED'). (suggestion)
  • Line 1: Spell out 'ADDED', if it's unfamiliar to the audience. (suggestion)
  • Line 3: Use parentheses judiciously. (suggestion)
  • Line 4: Spell out 'ABC', if it's unfamiliar to the audience. (suggestion)

site/about/glossary/_validmind-features.qmd

  • Line 7: In general, use active voice instead of passive voice ('are used'). (suggestion)
  • Line 7: Use parentheses judiciously. (suggestion)

site/about/glossary/_validmind.qmd

  • Line 3: In general, use active voice instead of passive voice ('are intertwined'). (suggestion)
  • Line 5: Use parentheses judiciously. (suggestion)
  • Line 6: Use 'open source' instead of 'open-source'. (warning)
  • Line 6: Use parentheses judiciously. (suggestion)
  • Line 6: Did you really mean 'overfit'? (error)
  • Line 8: Use parentheses judiciously. (suggestion)
  • Line 9: Use parentheses judiciously. (suggestion)
  • Line 9: Did you really mean 'APIs'? (error)

site/about/glossary/glossary.qmd

  • Line 7: Spell out 'NEW', if it's unfamiliar to the audience. (suggestion)
  • Line 7: Spell out 'TERM', if it's unfamiliar to the audience. (suggestion)
  • Line 7: Spell out 'NEEDS', if it's unfamiliar to the audience. (suggestion)
  • Line 7: In general, use active voice instead of passive voice ('BE ADDED'). (suggestion)
  • Line 7: Spell out 'ADDED', if it's unfamiliar to the audience. (suggestion)
  • Line 9: Spell out 'ABC', if it's unfamiliar to the audience. (suggestion)
  • Line 9: Use parentheses judiciously. (suggestion)
  • Line 9: Use 'for example' instead of 'e.g.'. (error)
  • Line 10: Spell out 'KEY', if it's unfamiliar to the audience. (suggestion)
  • Line 10: Spell out 'TERMS', if it's unfamiliar to the audience. (suggestion)
  • ... and 9 more issues

site/about/glossary/key_concepts/_docs.qmd

  • Line 4: Use 'app' instead of 'application'. (warning)

site/about/glossary/key_concepts/_inputs.qmd

  • Line 2: In general, use active voice instead of passive voice ('be evaluated'). (suggestion)
  • Line 4: In general, use active voice instead of passive voice ('been initialized'). (suggestion)
  • Line 4: Use parentheses judiciously. (suggestion)
  • Line 5: In general, use active voice instead of passive voice ('been initialized'). (suggestion)
  • Line 5: Use parentheses judiciously. (suggestion)
  • Line 6: In general, use active voice instead of passive voice ('is used'). (suggestion)
  • Line 7: In general, use active voice instead of passive voice ('is used'). (suggestion)
  • Line 7: Use parentheses judiciously. (suggestion)

site/about/glossary/key_concepts/_key-concepts.qmd

  • Line 1: Spell out 'KEY', if it's unfamiliar to the audience. (suggestion)
  • Line 1: Spell out 'NEEDS', if it's unfamiliar to the audience. (suggestion)
  • Line 1: In general, use active voice instead of passive voice ('BE ADDED'). (suggestion)
  • Line 1: Spell out 'ADDED', if it's unfamiliar to the audience. (suggestion)
  • Line 3: Use parentheses judiciously. (suggestion)
  • Line 5: Use parentheses judiciously. (suggestion)
  • Line 5: Use 'for example' instead of 'e.g.'. (error)
  • Line 5: Spell out 'ABC', if it's unfamiliar to the audience. (suggestion)

site/about/glossary/key_concepts/_metrics.qmd

  • Line 2: Use 'don't' instead of 'do not'. (suggestion)
  • Line 2: In general, use active voice instead of passive voice ('be registered'). (suggestion)
  • Line 2: In general, use active voice instead of passive voice ('be used'). (suggestion)
  • Line 4: In general, use active voice instead of passive voice ('be thought'). (suggestion)

site/about/glossary/key_concepts/_monitoring-template.qmd

  • Line 2: In general, use active voice instead of passive voice ('be tracked'). (suggestion)
  • Line 2: In general, use active voice instead of passive voice ('be conducted'). (suggestion)
  • Line 2: In general, use active voice instead of passive voice ('be displayed'). (suggestion)
  • Line 4: Did you really mean 'boilerplates'? (error)

site/about/glossary/key_concepts/_outputs.qmd

  • Line 2: Use parentheses judiciously. (suggestion)
  • Line 2: 's.D' should have one space. (error)

site/about/glossary/key_concepts/_parameters.qmd

  • Line 2: In general, use active voice instead of passive voice ('be passed'). (suggestion)

site/about/glossary/key_concepts/_template.qmd

  • Line 2: In general, use active voice instead of passive voice ('be run'). (suggestion)
  • Line 2: In general, use active voice instead of passive voice ('be displayed'). (suggestion)
  • Line 5: Did you really mean 'validators'? (error)
  • Line 7: Did you really mean 'boilerplates'? (error)

... and 653 more files with issues

@github-actions
Copy link
Contributor

Validate docs site

✓ INFO: A live preview of the docs site is available — Open the preview

@nrichers
Copy link
Collaborator Author

nrichers commented Oct 8, 2025

As per @validbeck in #966:

Good enough — most of the major issues are resolved in this. Can we make a note that the underline on hover still doesn't work on notebooks and to take a look at that as we continue to clean up our CSS?

@nrichers nrichers changed the title Improve navigation for Python API and Public REST API Improve navigation for Python API and Public REST API — DO NOT MERGE Oct 24, 2025
@nrichers nrichers added the DO NOT MERGE PR is not ready to be merged label Oct 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

DO NOT MERGE PR is not ready to be merged internal Not to be externalized in the release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants