Skip to content

quickstart: Model Development #748

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 18 commits into from
Jun 11, 2025

Conversation

validbeck
Copy link
Collaborator

@validbeck validbeck commented Jun 10, 2025

Internal Notes for Reviewers

sc-10570

Quickstart — Model Development

LIVE PREVIEW

Brand new introductory guide for model development/documentation, with cleaned up and refined information for a hopefully less confusing experience.

  • All the old cruft (register your first model, explore model documentation, document your model, etc. has been removed and is either covered in the new guide or will be wrapped into the other two quickstart guides). Broken links have been of course resolved with any shuffling.
  • There's now a get-started/common-assets folder for the steps I know will be repeated in the validation quickstart.
  • Speaking of broken links — re:installation branch: Had to push a quick commit to adjust the link here as the original file was replaced by this PR. cc: @nrichers
    Screenshot 2025-06-10 at 11 07 45 AM

How to test

You can pull this PR down and preview locally, or just click the live preview link above. ;)

Recommended review:

  • Test the steps to make sure they actually work as outlined. 🚨 NOTE THAT THE JUPYTERHUB LINK IS NOT LIVE YET AND IS CURRENTLY A BROKEN LINK 🚨 — aiming to resolve that before we push the quickstart changes to production. Fix pt1 here: https://github.com/validmind/demo-environment/pull/21
  • Confirm that the "learning outcome" (summary at the top of the page) is actually covered in the material.

External Release Notes

We've completely renovated our quickstart experience for model developers, aiming to present a more user-friendly introduction to using ValidMind for documenting models. This quickstart covers the basics of using ValidMind to develop models, walking you through how to register your first model, use the ValidMind Library to run tests and document a model, then review your generated model documentation using the ValidMind Platform.

This quickstart is the first in a series of new user journeys — look forward to our upcoming introductory guides for model validation and platform administration!

@validbeck validbeck self-assigned this Jun 10, 2025
@validbeck validbeck added documentation Improvements or additions to documentation highlight Feature to be curated in the release notes labels Jun 10, 2025
@validbeck validbeck requested review from nrichers and LoiAnsah June 10, 2025 18:17
Copy link
Contributor

PR Summary

This pull request introduces several enhancements to the documentation and workflow for model development using the ValidMind platform. Key changes include:

  1. Documentation Updates:

    • The Quickstart guide has been updated to focus on model development, replacing the previous QuickStart guide.
    • New sections have been added to guide users through accessing and running quickstart notebooks, downloading code samples, and registering models.
    • The documentation now includes detailed steps for using the ValidMind developer library to automate testing and documentation of models.
    • Several outdated or redundant documentation files have been removed to streamline the user experience.
  2. Content Reorganization:

    • The structure of the documentation has been reorganized to provide a clearer path for new users, emphasizing the use of JupyterHub and local environments for running notebooks.
    • The sidebar and navigation elements have been updated to reflect these changes, ensuring users can easily find the new quickstart resources.
  3. Content Additions:

    • New markdown files have been added to provide step-by-step instructions for accessing quickstart notebooks, downloading code samples, and running tests.
    • Visual aids, such as screenshots and diagrams, have been included to assist users in navigating the platform and understanding the workflow.

These changes aim to improve the onboarding experience for new users and provide a more cohesive and comprehensive guide to using the ValidMind platform for model development.

Test Suggestions

  • Verify that all links in the updated documentation point to the correct resources.
  • Test the new quickstart guide by following the steps to ensure they are clear and lead to successful model registration and documentation.
  • Check that the new markdown files render correctly and include all necessary information.
  • Ensure that the removal of outdated files does not break any existing links or references in the documentation.
  • Validate that the new navigation structure in the sidebar is intuitive and all sections are accessible.

Copy link
Contributor

PR Summary

This pull request introduces several enhancements to the documentation and workflow for model development using the ValidMind platform. Key changes include:

  1. Documentation Updates:

    • The Quickstart guide has been updated to focus on model development, with a new file quickstart-developer.qmd replacing the previous quickstart.qmd.
    • Several new markdown files have been added under site/get-started/common-assets/ to provide detailed steps for accessing and running quickstart notebooks, downloading code samples, and registering models.
    • The README and various .qmd files have been updated to reflect these changes, ensuring links and references are consistent with the new documentation structure.
  2. Content Reorganization:

    • The content related to trying the ValidMind developer framework in different environments has been consolidated and streamlined.
    • Obsolete files such as try-in-your-own-environment.qmd and try-with-jupyterhub.qmd have been removed, and their content has been integrated into the new quickstart documentation.
  3. Visual and Structural Enhancements:

    • New images and screenshots have been added to the documentation to provide visual guidance for users.
    • The sidebar and navigation elements have been updated to reflect the new documentation structure, improving user navigation and accessibility.

These changes aim to provide a more cohesive and user-friendly experience for new users getting started with model development on the ValidMind platform.

Test Suggestions

  • Verify that all links in the updated documentation point to the correct resources and do not result in 404 errors.
  • Test the new quickstart guide by following the steps to ensure they are clear and lead to successful model registration and documentation generation.
  • Check that all images and screenshots are correctly displayed and correspond to the described steps in the documentation.
  • Ensure that the removal of old files does not break any existing links or references in the documentation.
  • Validate that the new sidebar and navigation elements function correctly and improve user experience.

Copy link
Contributor

PR Summary

This pull request introduces several enhancements to the documentation and workflow for model development using the ValidMind platform. Key changes include:

  1. Documentation Updates:

    • The Quickstart guide has been updated to focus on model development, with a new file quickstart-developer.qmd replacing the older quickstart.qmd.
    • Several new markdown files have been added under site/get-started/common-assets/ to provide detailed steps for accessing and running quickstart notebooks, downloading code samples, and registering models.
    • The README has been updated to correct links and improve clarity.
  2. Content Reorganization:

    • The content related to trying the ValidMind developer framework in different environments has been consolidated and streamlined.
    • Obsolete files such as try-in-your-own-environment.qmd and try-with-jupyterhub.qmd have been removed, and their content has been integrated into the new quickstart guide.
  3. Visual and Structural Enhancements:

    • New images and screenshots have been added to improve the visual appeal and clarity of the documentation.
    • The sidebar and navigation have been updated to reflect the new structure, ensuring users can easily find the quickstart resources.
  4. Removal of Deprecated Content:

    • Several outdated quickstart and tutorial files have been removed to reduce clutter and focus on the most effective onboarding paths for new users.

These changes aim to provide a more cohesive and user-friendly experience for new users getting started with model development on the ValidMind platform.

Test Suggestions

  • Verify that all links in the updated documentation point to the correct resources.
  • Test the new quickstart guide by following the steps to ensure they lead to successful model registration and documentation generation.
  • Check that all images and screenshots are correctly displayed and relevant to the accompanying text.
  • Ensure that the removal of old files does not break any existing links or references in the documentation.
  • Validate that the new sidebar navigation correctly reflects the updated documentation structure.

Copy link
Contributor

Vale source linter

⚠️ WARN: Found 13139 issues across 604 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: Spell out all ordinal numbers ('1st') in text. (error)
  • Line 4: Put a nonbreaking space between the number and the unit in '1s'. (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 574 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: d5a4de6

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.75 0.78 1.00 0.89
/get-started/get-started.html 0.76 0.84 1.00 0.80
/guide/guides.html 0.76 0.86 1.00 0.90
/index.html 0.79 0.83 1.00 0.80
/releases/all-releases.html 0.85 0.88 1.00 0.80
/support/support.html 0.82 0.87 1.00 0.90
/training/training.html 0.73 0.70 0.96 0.80

Copy link
Contributor

Validate docs site

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

Copy link
Contributor

@LoiAnsah LoiAnsah left a comment

Choose a reason for hiding this comment

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

I have reviewed the new generated model development and ran the Notebook (locally). Everything works!

@validbeck validbeck merged commit d43be1a into main Jun 11, 2025
5 checks passed
@validbeck validbeck deleted the beck/sc-10570/new-model-development-get-started branch June 11, 2025 16:28
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.

Great PR, mainly just some stylistic comments — will approve after these are addressed. 🚀 It's GREAT to see us remove some of the last vestiges of our early smoke-and-mirrors docs site. 🙌

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.

3 participants