Skip to content

Docs site audit part 2 - inline link cleanup #222

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 21, 2024

Conversation

validbeck
Copy link
Collaborator

@validbeck validbeck commented Jun 20, 2024

External Release Notes

For sc-4898, I:

  • Added vm_login to the _variables.yml file & changed all instances of "1. [Log in to the {{< var vm_platform >}}]({{< var vm_url >}})." to "1. Log in to the {{< var vm_login >}}."
  • Adjusted the hacky CSS on customize-documentation-templates.qmd to match the new link styling applied in PR#217
  • Established a convention in the style guide for .column-margin content and used this to pull out extraneous links from step-by-step instructions or text
  • Reviewed extraneous bolding of links where appropriate
  • Retooled the "About ValidMind" landing page to include "Automated testing & documentation" & "Model risk governance management" (removed the "Features" section from About)

Major changes

variables.yml

Added vm_login: "[ValidMind Platform UI](https://app.prod.validmind.ai)"

  • Changed all instances of "1. [Log in to the {{< var vm_platform >}}]({{< var vm_url >}})." to "1. Log in to the {{< var vm_login >}}."
  • For some articles that did not have the first login step but required it, I made a quick adjustment as I was working

Customize documentation templates

Adjusted the hacky CSS on customize-documentation-templates.qmd to match the new link styling applied in PR#217

.column-margin content

New section in the style guide for inline links/margin content rationale & guidance:

style-guide_margins
  • Reviewed all articles for extraneous links, especially in step-by-step instructions and applied this new margin styling instead when appropriate (or did not mess with single-sourced training, etc.):
Old New
inline-links_incorrect margin-content_correct

About

Retooled the "About ValidMind" landing page to include "Automated testing & documentation" & "Model risk governance management" (removed the "Features" section from About)

  • Now there are some fancy cards under "ValidMind AI risk platform" with links out to the relevant docs instead of the nebulous Read more ...
  • The two linked pages got some quick cleanup as well to remove the Read more ...s
Page Old New
About ValidMind about-old Screenshot 2024-06-20 at 1 59 05 PM
Automated testing & documentation old-automation new-automation
Model risk governance management new-mrm old-mrm

Other changes

Following our own rules about minimizing callouts and unnecessary repeats of text and tricky conditional displays etc.

Page Old New
Review model documentation review-docs_old review-docs_new
Collaborate with others collab_old collab_new

Other notes

I noticed that some images don't have alt text as per our style guide so I will add that to the list for the next review.

@validbeck validbeck added the internal Not to be externalized in the release notes label Jun 20, 2024
@validbeck validbeck self-assigned this Jun 20, 2024
@validbeck validbeck requested review from nrichers and noosheenv June 20, 2024 21:08
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! My only comment is that we should use bullets OR superscript numbers but not both. I'd globally change callouts to look like this:

image

@validbeck
Copy link
Collaborator Author

@nrichers:

Just removed the numeration from this page:
Screenshot 2024-06-20 at 4 38 00 PM

Removed the bullet points from any pages with margin lists:
Screenshot 2024-06-20 at 4 57 27 PM

@validbeck validbeck merged commit 9a55966 into main Jun 21, 2024
2 checks passed
@validbeck validbeck deleted the beck/sc-4898/docs-site-audit-style-guide-cleanup branch June 21, 2024 16:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
internal Not to be externalized in the release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants