Skip to content

ValidMind Style Guide#174

Merged
validbeck merged 9 commits intomainfrom
style-guide
Apr 25, 2024
Merged

ValidMind Style Guide#174
validbeck merged 9 commits intomainfrom
style-guide

Conversation

@validbeck
Copy link
Copy Markdown
Collaborator

@validbeck validbeck commented Apr 25, 2024

Internal Notes for Reviewers

Created the ValidMind Style Guide and moved a bunch of the Overview articles into a new "About" section.

ValidMind Style Guide & About section

Shortcut Story: [sc-3683]

Style Guide

Ask and ye shall receive; the 1st official version is ready for publication!

About Section

Moved the following to an About section, in the leftmost corner of the top navigation:

Landing page

  • What is ValidMind?

Features

  • Automated model testing & documentation
  • Model risk governance management

References

  • ValidMind Style Guide (new)
  • ValidMind Glossary (wip)
  • Data privacy policy
  • Software license agreement

Releases

Self-explanatory!

I double-checked all the images and links to make sure they lived in the right folder for all of the pages I moved and that they were adjusted so they weren't broken after migration. :)

External Release Notes

ValidMind Style Guide & About section

About ValidMind

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

  • What is ValidMind? serves as the landing page for this section
  • Product overviews now live here under Features
  • Tools such as the new style guide, the product glossary, our data privacy policy, and our software license agreement live here under References
  • Releases have been moved here as well

ValidMind Style Guide

Check out the first official version of the ValidMind Style Guide! 🎉 ✍️

  • Learn about the ValidMind voice
  • Understand our shared vision and goals
  • See our references for formatting conventions
  • & more!

@validbeck validbeck added the documentation Improvements or additions to documentation label Apr 25, 2024
@validbeck validbeck self-assigned this Apr 25, 2024
@github-actions
Copy link
Copy Markdown
Contributor

Pull requests must include a description in the release notes section.

1 similar comment
@github-actions
Copy link
Copy Markdown
Contributor

Pull requests must include a description in the release notes section.

Copy link
Copy Markdown
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! I left some comments for you to address. 🚀

@github-actions
Copy link
Copy Markdown
Contributor

Pull requests must include a description in the release notes section.

@github-actions
Copy link
Copy Markdown
Contributor

Pull requests must include a description in the release notes section.

Copy link
Copy Markdown
Collaborator Author

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

Added the suggestions Nik had for the vision callout and the bolding bullet point.

@github-actions
Copy link
Copy Markdown
Contributor

Pull requests must include a description in the release notes section.

1 similar comment
@github-actions
Copy link
Copy Markdown
Contributor

Pull requests must include a description in the release notes section.

Copy link
Copy Markdown
Collaborator Author

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

Added spaces after and before the < and > respectively on Nik's suggestion; not sure why they don't render properly for him otherwise but this version renders fine for me as well

@github-actions
Copy link
Copy Markdown
Contributor

Pull requests must include a description in the release notes section.

@github-actions
Copy link
Copy Markdown
Contributor

Pull requests must include a description in the release notes section.

2 similar comments
@github-actions
Copy link
Copy Markdown
Contributor

Pull requests must include a description in the release notes section.

@github-actions
Copy link
Copy Markdown
Contributor

Pull requests must include a description in the release notes section.

@validbeck
Copy link
Copy Markdown
Collaborator Author

@nrichers How do I resolve this error? I've included release notes (unless I did it incorrectly?), I'm pretty sure!

Screenshot 2024-04-25 at 3 41 17 PM

Copy link
Copy Markdown
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! Let's figure out placement of the section later. :shipit:

@nrichers nrichers deleted the 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