Skip to content

Updated the About section to break down the articles into new categor… #176

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 5 commits into from
Apr 26, 2024

Conversation

validbeck
Copy link
Collaborator

Internal Notes for Reviewers

  • I called quarto render this time and checked the static files in _site, so hopefully everything goes smoothly...
  • I've updated the old Style Guide in Notion by sending it to the Community archives and linking out to the new publicly hosted version
  • @nrichers, after you approve, permission to send this to prod and update the site thru AWS? Thank you!

Question: How do we reindex the pages for Google search? We touched on this briefly yesterday but I can't remember if we performed that action.

Updated "About" section

About Before About After
old_about about_vm
  • Changed the sidebar link for What is ValidMind? to About ValidMind to match the structure of the landing page titles

Features

  • Made some small changes to two pages based on how we talk about these features on the VM WordPress site:
    • Adjusted the link for the automation page to Automated testing & documentation (left the full title on the page itself)
    • Adjusted the title for Model risk governance management to Model risk management & governance
Old automation link New automation link
old_about automation
Old governance page New governance page
old_governance governance
  • Moved ValidMind glossary here, to break out the terms and style guide into their own sections (see below)

Contributing

community
  • Added a brand spankin' new The ValidMind community page, complete with invitations to participate and contribute
  • Moved the "ValidMind style guide" here, and made two adjustments to the contents:
    • Added an example for highlighting UI elements under Emphasis
    • Added a note under Product names to caveat that variables will not work in .ipynb
Emphasis Variables
emphasis variables

Fineprint

fineprint
  • Data privacy policy and Software license agreement live here now under Releases

Purge external release notes for #174

  • Please ignore the half-baked version of the external release notes on pull request #174 and go with the below version instead

External Release Notes

about_vm

About ValidMind

We've revamped our documentation for a cleaner, more intuitive experience, featuring a brand new About section:

  • Product overviews and our glossary now live here under Features
  • Releases have been moved here as well
  • Important documents such as our terms are under Fineprint

Contributing

Under this section you'll also find a brand new set of guides on Contributing, where you learn how to engage with the ValidMind community, read about our brand voice and vision, and more!

…ies: Features, Contributing, & Fineprint. Also added a brand new The ValidMind community page.
@validbeck validbeck added the documentation Improvements or additions to documentation label Apr 26, 2024
@validbeck validbeck self-assigned this Apr 26, 2024
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.

LGTM! (Looks GREAT to me) 🚀

Left a couple of small comments to address before merging.

@validbeck validbeck merged commit b7b2713 into main Apr 26, 2024
@nrichers nrichers deleted the beck/sc-3683/validmind-style-guide branch May 1, 2024 18:30
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.

2 participants