Skip to content

Update validation report user guide & tweak model documentation landing page #158

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 8 commits into from
Mar 14, 2024

Conversation

nrichers
Copy link
Collaborator

@nrichers nrichers commented Mar 12, 2024

Internal Notes for Reviewers

This PR:

  • Expands our validation report user guide section, esp. around assessing compliance, linking evidence & findings.
  • Adapts the model documentation user guide to follow the same mini landing page design from the validation report section.
  • Edits the short descriptions of child topics in each section to work better with the landing page format
  • Lots of other smaller edits & tweaks after testing

Major output changes

Capto_Capture 2024-03-14_02-27-39_AM

Capto_Capture 2024-03-14_02-27-46_AM

Capto_Capture 2024-03-14_02-27-56_AM

New landing page for

External Release Notes

The user guides section for working with model documentation and preparing validation reports have been expanded with new landing pages, better procedural task steps, and more contextual information.

Learn more:

Copy link

This pull request has been linked to Shortcut Story #3329: Author guide/link-to-evidence.qmd.

@nrichers nrichers marked this pull request as draft March 12, 2024 19:57
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.

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 the documentation Improvements or additions to documentation label Mar 13, 2024
Copy link
Contributor

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

@nrichers nrichers marked this pull request as ready for review March 14, 2024 09:31
@nrichers
Copy link
Collaborator Author

We need this PR live for our Zopa session tomorrow, merging as is.

@nrichers nrichers merged commit b9ab6d3 into main Mar 14, 2024
@nrichers nrichers deleted the nrichers/sc-3329/author-guide-link-to-evidence-qmd branch March 14, 2024 09:39
@nrichers nrichers changed the title Update validation report user guide & tweak model doucmentation landing page — IN PROGRESS, DO NOT REVIEW Update validation report user guide & tweak model doucmentation landing page Mar 14, 2024
@nrichers nrichers changed the title Update validation report user guide & tweak model doucmentation landing page Update validation report user guide & tweak model documentation landing page Mar 14, 2024
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.

1 participant