Edited the FAQ testing file (faq-testing.qmd). Added 2 new sections.

[LoiAnsah]

Pull Request Description

Changes:

Updated the FAQ section. We added testing scenarios for Developers and Validators about how to log tests.

New

How to test it:

You can take a look at the git diffs:

Pull down this PR: gh pr checkout 722
1- Open documentation/site/faq/faq-testing.qmd
2- Call cd site in your terminal to navigate into the site directory where our docs site files live.
3- Call quarto preview to pull up a live version of the changed site.

[CLAassistant]

All committers have signed the CLA.

[github-actions]

PR Summary

This pull request enhances the FAQ documentation by adding detailed instructions on how to log tests both as a developer and as a validator using the validmind.developer tool. The new sections provide step-by-step guidance on the roles required and the process to follow for logging tests during model development and validation. Additionally, it includes links to further resources and introductory series for both developers and validators to better understand the use of the validmind.product platform.

Key Additions:

• Logging Tests as a Developer:

  • Requirements for the Developer role and permissions.
  • Steps to log tests and update model documentation.
  • Link to introductory series for model development.

• Logging Tests as a Validator:

  • Requirements for the Validator role and permissions.
  • Steps to log tests and update validation reports.
  • Link to introductory series for model validation.

These additions aim to improve the clarity and usability of the documentation for users involved in model development and validation processes.

Test Suggestions

• Verify that the new documentation sections are correctly formatted and rendered on the site.
• Check that all links in the new sections point to the correct resources and are functional.
• Ensure that the role and permission requirements are accurately described and match the system's role management settings.
• Review the introductory series links to confirm they lead to the correct content for developers and validators.

[validbeck]

Nice! Let's talk on Tuesday about merging and what else you need to do before that happens (we want to double check that everything will look good on the live site!).

[github-actions]

PR Summary

This pull request enhances the FAQ section of the documentation by adding detailed instructions on how to log tests both as a developer and as a validator using the validmind.developer tool. The new sections provide step-by-step guidance on the roles and permissions required for logging tests and updating documentation or validation reports. Additionally, callouts are included to direct users to introductory series for further learning about using the validmind.product for model development and validation. The changes also include new footnotes for further reading and context.

Key Additions:

• Instructions for logging tests as a developer, including role requirements and permissions.
• Instructions for logging tests as a validator, including role requirements and permissions.
• Callouts with links to introductory series for developers and validators.
• Additional footnotes for further reading and context.

Test Suggestions

• Verify that the new documentation sections for logging tests as a developer and validator are correctly formatted and rendered in the FAQ.
• Check that all links in the new documentation sections are functional and lead to the correct resources.
• Ensure that the callouts for the introductory series are displayed correctly and link to the appropriate sections.
• Review the footnotes to confirm they provide accurate and helpful additional information.

[nrichers]

LGTM! I got Ama to walk me through the changes in the output site. We discussed how many related links are useful — for a FAQ having more is helpful whereas for a task topic fewer links might be better. Checked the source as well.

Congratulations on your first contribution to our docs site, @LoiAnsah! 🙌