Skip to content

Platform overview rewrite #138

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 11 commits into from
Oct 18, 2023
Merged

Platform overview rewrite #138

merged 11 commits into from
Oct 18, 2023

Conversation

nrichers
Copy link
Collaborator

@nrichers nrichers commented Oct 12, 2023

Internal Notes for Reviewers

This PR reworks and expands the ValidMind overview section in our docs site:

image

What's new:

  • Messaging is now much more in line with the ValidMind_Product Deck & Tech Architecture_09 26 2023, especially for coverage of the ValidMind Developer Framework
  • There is additional background information for model risk management that ties our products to regulatory compliance, with reference to SR 11-7 and SS1/23 (what was the request to add knowledge base articles)
  • There is a placeholder for a future product tour but it is commented out for now.

Overall, this PR represents an iterative improvement for our product overview in terms of content and SEO performance. More to come.

Output

Capto_Capture 2023-10-12_09-03-00_pm

Capto_Capture 2023-10-12_09-03-06_pm

Capto_Capture 2023-10-12_10-14-43_pm

External Release Notes

We expanded our platform overview to provide more background information about what ValidMind offers and how we enable you to comply with policies and regulations such as SR 11-7 and SS1/23. Read more ...

@nrichers nrichers marked this pull request as draft October 12, 2023 19:13
@github-actions
Copy link
Contributor

Pull requests must include at least one of the required labels: internal, highlight, enhancement, bug, deprecation, documentation. Except for internal, pull requests must also include a description in the release notes section.

@github-actions
Copy link
Contributor

Pull requests must include at least one of the required labels: internal, highlight, enhancement, bug, deprecation, documentation. Except for internal, pull requests must also include a description in the release notes section.

1 similar comment
@github-actions
Copy link
Contributor

Pull requests must include at least one of the required labels: internal, highlight, enhancement, bug, deprecation, documentation. Except for internal, pull requests must also include a description in the release notes section.

@nrichers nrichers added documentation Improvements or additions to documentation highlight Feature to be curated in the release notes labels Oct 13, 2023
@github-actions
Copy link
Contributor

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

1 similar comment
@github-actions
Copy link
Contributor

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

@github-actions
Copy link
Contributor

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

@github-actions
Copy link
Contributor

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

@nrichers nrichers changed the title Platform overview rewrite  — DO NOT REVIEW Platform overview rewrite Oct 13, 2023
@cachafla
Copy link
Contributor

The model risk governance page is great 🙌.

Looks good to me. I only have a couple of comments:

  • This image refers to a old code snippet that does not work anymore:
image

We left it on the slides but haven't got the time to update it. The developer framework has changed so much that those lines of code are no longer valid.

  • On the API integration section I would add an additional disclaimer that ValidMind does not store customer datasets or models. This is a recurring question we get from customers and it's good to have a explicit call out on our docs.

@nrichers nrichers marked this pull request as ready for review October 17, 2023 15:11
@nrichers
Copy link
Collaborator Author

Thank you for the review, @cachafla! Much appreciated.

  • This image refers to a old code snippet that does not work anymore

Those are actual codeblocks (not an image), so if you have some suggestions for code you'd prefer to see, just let me know? No one will ever try to run this code, so it's really just meant to highlight a bit of what we provide and then leave it at that.

On the API integration section I would add an additional disclaimer that ValidMind does not store customer datasets or models.

Done! I rewrote the existing disclaimer to include that info:

image

Copy link
Contributor

@cachafla cachafla left a comment

Choose a reason for hiding this comment

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

Great 😎

@nrichers nrichers merged commit ae55970 into main Oct 18, 2023
@nrichers nrichers deleted the knowledge-base branch October 18, 2023 20:53
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