Skip to content

New Homepage integration #743

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

Open
wants to merge 36 commits into
base: main
Choose a base branch
from

Conversation

LoiAnsah
Copy link
Contributor

@LoiAnsah LoiAnsah commented Jun 2, 2025

Internal Notes for Reviewers

https://app.shortcut.com/validmind/story/10590/implement-new-homepage-design

Homepage:

I attempted to update our homepage using our most recent design.

Design:
Screenshot 2025-05-23 at 4 58 34 PM

My implementation:
Screenshot 2025-06-03 at 1 29 07 PM

As you can see, I am missing some components:
Footer: I have had issues making it appear on all pages.
header: removing the search item at the very right
text: Centring the text under "Validmind Tour"

How to test

Since the online preview won't display the notebook iFrames correctly (it pulls the relative link from the root of the docs-demo repo rather than the PR branch):

  1. Grab this PR: gh pr checkout 743

  2. Make sure you're in the site directory if you're not already: cd site

  3. Pull up a live preview: quarto preview
    Review the homepage of the doc site.

@LoiAnsah LoiAnsah requested a review from nrichers June 3, 2025 17:40
@LoiAnsah LoiAnsah self-assigned this Jun 3, 2025
Copy link
Contributor

github-actions bot commented Jun 3, 2025

PR Summary

This pull request introduces several new files and updates to the ValidMind platform's documentation and styling. Key changes include:

  1. New Documentation Pages: Added QuickStart guides for different user roles including administrators, developers, and validators. These guides provide step-by-step instructions for setting up and using the ValidMind platform.

    • site/get-started/quickstart-administrator.qmd
    • site/get-started/quickstart-developer.qmd
    • site/get-started/quickstart-validator.qmd
  2. Styling Enhancements: Introduced new CSS styles to improve the visual appearance of the platform's documentation site. This includes changes to the global styles, specific component styles, and the addition of new SVG assets for icons and logos.

    • anima/globals.css
    • anima/style.css
    • anima/styleguide.css
    • site/styles.css
  3. HTML and SVG Assets: Added new HTML structure for the homepage and several SVG files for visual elements like icons and logos.

    • anima/index.html
    • site/homepage_docsite/*.svg
  4. Configuration Updates: Modified the Quarto configuration file to adjust the website's metadata and layout settings.

    • site/_quarto.yml
  5. API Documentation Updates: Updated the ValidMind Library Python API documentation to reflect new features and changes in the API.

    • site/validmind/validmind.qmd
    • site/validmind/validmind/version.qmd
    • site/validmind/validmind/vm_models.qmd

Test Suggestions

  • Verify that the new QuickStart guides are accessible and display correctly on the documentation site.
  • Check that the new CSS styles are applied correctly across different pages and components.
  • Ensure that the SVG assets are loading properly and are visually correct.
  • Test the functionality of the updated API documentation to ensure all links and references are correct.
  • Validate that the configuration changes in _quarto.yml do not break the site layout or functionality.

…o ama8636/sc-10161/test-generating-docs-site-artifacts-via-mcp
Copy link
Collaborator

@nrichers nrichers left a comment

Choose a reason for hiding this comment

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

@LoiAnsah this is a solid and substantial PR — great work pulling all of this together. 🙌

I’ve left a few comments and suggestions to address before I review again. Once you’ve made the changes, please re-request review by clicking the icon next to my name in the reviewers section.

@nrichers
Copy link
Collaborator

nrichers commented Jun 3, 2025

Also, your PR needs at least some labels — I would recommend documentation and highlight, plus some external release notes content that explains we have a new home page design. It's a great new look, so let's socialize it in our release notes!

@LoiAnsah
Copy link
Contributor Author

LoiAnsah commented Jun 3, 2025

@nrichers Thank you for the review. I will go through each section you highlighted and fix the issues.

@LoiAnsah LoiAnsah added documentation Improvements or additions to documentation highlight Feature to be curated in the release notes labels Jun 3, 2025
@LoiAnsah LoiAnsah requested a review from nrichers June 4, 2025 22:41
Copy link
Contributor

github-actions bot commented Jun 4, 2025

PR Summary

This pull request introduces several enhancements to the ValidMind documentation and user interface. Key changes include:

  1. Navigation and Layout Adjustments:

    • The position of the announcement content on the website has been changed from below the navbar to above the navbar.
    • The left navigation menu has been significantly reduced, and a new right navigation menu has been introduced with updated links to documentation, support, releases, and training.
    • The footer has been redesigned with a new layout, including sections for Platform, Solutions, Community, Resources, and Company.
  2. New QuickStart Guides:

    • Three new QuickStart guides have been added for Setup & Administration, Model Development, and Model Validation. These guides are designed to help users quickly get started with the ValidMind platform.
  3. Visual and Style Updates:

    • New SVG icons have been added for various sections, including setup, model development, model validation, and releases.
    • The CSS has been updated to improve the visual appearance of the site, including changes to button styles, background colors, and text colors.
    • A new tour section has been added to the homepage to provide an overview of the ValidMind platform.
  4. New Product Tour:

    • A new product tour has been added to the training section, providing an interactive guide to the ValidMind platform.

These changes aim to improve the user experience by providing clearer navigation, updated visual elements, and new resources for getting started with the platform.

Test Suggestions

  • Verify that the announcement content appears above the navbar on the website.
  • Check that the new right navigation menu links are functional and lead to the correct pages.
  • Ensure that the new QuickStart guides are accessible and display the correct content.
  • Test the new footer layout to ensure all links are functional and correctly categorized.
  • Verify that the new SVG icons are displayed correctly across different browsers.
  • Test the new product tour to ensure it is interactive and provides the intended guidance.
  • Check the overall site for any broken links or missing resources after the updates.

Copy link
Collaborator

@nrichers nrichers left a comment

Choose a reason for hiding this comment

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

I'm still reviewing your latest implementation of the new home page and one item we need to sort out for sure is the footer:

  • Currently the links 404 when they should work
  • The footer is lifted from the main site but it really should have more content that is related to the docs site itself, as it should serve as a mini sitemap (and also link to the new sitemap.html)

Let's do a bit of brainstorming about what would make sense to include here, but there is some prior art in this frame of a working board we had in Miro: https://miro.com/app/board/uXjVIUysCKM=/?moveToWidget=3458764622028594416&cot=14

@LoiAnsah LoiAnsah requested a review from nrichers June 10, 2025 21:39
Copy link
Contributor

PR Summary

This pull request introduces several enhancements to the ValidMind documentation and user interface. Key changes include:

  1. Navigation and Layout Adjustments:

    • The announcement banner position has been changed from below-navbar to above-navbar.
    • The footer has been redesigned with a new layout, including sections for user guides, company info, and community links.
    • The navigation menu has been updated to include new documentation links and reorganized sections for better accessibility.
  2. New Quickstart Guides:

    • Added new quickstart guides for administrators, developers, and validators to help users set up their organization, develop models, and validate models using the ValidMind platform.
  3. Styling and Theming:

    • Updated styles for buttons, links, and other UI elements to improve consistency and readability.
    • Introduced a new color scheme and background images for various sections of the site.
  4. SVG Assets:

    • Added new SVG assets for icons and logos to enhance the visual appeal of the site.
  5. Product Tour:

    • Introduced a new product tour page to guide users through the features and functionalities of the ValidMind platform.

These changes aim to improve the user experience by providing clearer navigation, more comprehensive guides, and a visually appealing interface.

Test Suggestions

  • Verify that the announcement banner appears above the navbar and displays correctly.
  • Check that the new footer layout is responsive and all links are functional.
  • Ensure that the new quickstart guides are accessible and the content is accurate.
  • Test the navigation menu to confirm that all links lead to the correct pages.
  • Validate that the new SVG assets are displayed correctly across different browsers.
  • Conduct a usability test for the product tour to ensure it provides a clear and informative experience.

@LoiAnsah
Copy link
Contributor Author

Hi @nrichers, The branch is now up to date with my latest changes.

Screenshot 2025-06-10 at 5 38 43 PM

I am having a problem moving the cookie preferences to the corner. Will try fixing it but I am open to any hint.

@nrichers
Copy link
Collaborator

I am having a problem moving the cookie preferences to the corner. Will try fixing it but I am open to any hint.

As discussed at our standup, I'll re-review when you have made some more changes to the footer, @LoiAnsah.

Please do ask for me to help out with changes where you think it would be helpful — for placement of cookie-consent-footer, I suggest adding some CSS that will force the link to appear where we want it, right below the footer-company-info div.

@nrichers
Copy link
Collaborator

@LoiAnsah one last comment before I wait for your request to re-review: please check that there are no WARN messages in the Quarto output that need to be resolved? E.g. the current version of your PR has some broken links:

WARN: Unable to resolve link target: get-started/onboarding.qmd
WARN: Unable to resolve link target: get-started/model-inventory.qmd
WARN: Unable to resolve link target: get-started/whats-new.qmd
WARN: Unable to resolve link target: developer/code-samples.qmd
WARN: Unable to resolve link target: training/courses.qmd
WARN: Unable to resolve link target: training/videos.qmd

@LoiAnsah
Copy link
Contributor Author

@nrichers Hi Nik, I have pushed my latest changes for the footer.

@LoiAnsah LoiAnsah force-pushed the ama8636/sc-10161/test-generating-docs-site-artifacts-via-mcp branch from 7e63ebe to 9edeea7 Compare June 13, 2025 18:32
Copy link
Contributor

Vale source linter

⚠️ WARN: Found 13434 issues across 612 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 182 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 11: Try to avoid using first-person plural like 'our'. (warning)
  • Line 11: Use parentheses judiciously. (suggestion)
  • Line 11: Don't use exclamation points in text. (error)
  • Line 12: Try to avoid using first-person plural like 'our'. (warning)
  • Line 12: Use parentheses judiciously. (suggestion)
  • ... and 36 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 4: Did you really mean 'boilerplates'? (error)

... and 582 more files with issues

Copy link
Contributor

Lighthouse check results

⚠️ WARN: Average accessibility score is 0.78 (required: >0.9) — Check the workflow run

Show Lighthouse scores

Folder depth level checked: 0

Commit SHA: f338903

Modify the workflow to check a different depth:

  • 0: Top-level navigation only — /index.html, /guide/guides.html, ...
  • 1: All first-level subdirectories — /guide/.html, /developer/.html, ...
  • 2: All second-level subdirectories — /guide/attestation/*.html, ...
Page Accessibility Performance Best Practices SEO
/developer/validmind-library.html 0.73 0.60 1.00 0.90
/get-started/get-started.html 0.76 0.78 1.00 0.80
/guide/guides.html 0.76 0.86 1.00 0.90
/index.html 0.79 0.90 1.00 0.80
/releases/all-releases.html 0.85 0.87 1.00 0.80
/support/support.html 0.82 0.86 1.00 0.90
/training/training.html 0.73 0.88 0.96 0.80

Copy link
Contributor

Validate docs site

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

nrichers

This comment was marked as off-topic.

Copy link
Collaborator

@nrichers nrichers left a comment

Choose a reason for hiding this comment

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

ARRGH! Wrong PR, this one still needs changes, which I will handle. Please ignore ...

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 highlight Feature to be curated in the release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants