Docs — Revamped FAQs

[validbeck]

Internal Notes for Reviewers

sc-6528

FAQ

LIVE PREVIEW

Brand spanking new landing page with a table listing:

Old	New

New FAQ pages

• Access & permissions
• Model workflows
• Inventory & activity (I combined the old "Model registration" and "Model inventory" pages
• Documentation & templates
• Validation & findings
• Collaboration
• Monitoring & reporting
• Testing
• Integrations & support
• Data & privacy

1. Some of the questions are now single-sourced, allowing them to live on multiple pages or have info that's sourced from elsewhere in the docs
2. The logic for the footnotes or "Learn more" sections at the bottom of the page were "Granular guide for a specific task" (footnote) or "Overview of a topic that is covered more broadly on the page" (Learn more).

Support

This was actually taken care of in #540:

Old	New

Next steps

Replaced the FAQ list with the listing tile:

Old	New

[github-actions]

A PR preview is available: Preview URL

[github-actions]

A PR preview is available: Preview URL

[validbeck]

@cachafla @juanmleng Thank you for your help with these! Can you give these more technical questions a read-over to make sure nothing is missing/standing out as incorrect? 🙏🏻

• Documentation & templates
• Testing
• Integrations & support
• Data & privacy

[github-actions]

PR Summary

This pull request introduces several enhancements and restructuring to the FAQ and documentation files of the project. Key changes include:

1. Reorganization of FAQ Topics: The FAQ section has been restructured to provide a more organized and accessible format. Topics are now grouped by categories such as Access and Permissions, Model Workflows, Model Inventory and Activity, Model Documentation and Templates, Model Validation and Findings, Collaboration, Ongoing Monitoring and Reporting, Testing and Thresholds, Integrations and Support, and Data Handling and Privacy.

2. New FAQ Entries: Several new FAQ entries have been added, covering topics like model registration, customization of workflows, handling of synthetic datasets, and more.

3. Documentation Enhancements: The documentation now includes more detailed sections on collaboration features, submission for approval processes, and transition workflow examples.

4. Inclusion of New Files: New files have been added to support the expanded FAQ and documentation structure, such as _transition-workflow-examples.qmd and _submit-feedback.qmd.

5. Code Samples and Images: Updates to Jupyter notebooks and the inclusion of new images to support documentation examples.

6. Removal of Deprecated Content: Some outdated FAQ entries and documentation sections have been removed or replaced with updated content.

Test Suggestions

• Verify that all new FAQ entries are correctly linked and accessible from the main FAQ page.
• Check that the restructured FAQ categories improve navigation and usability.
• Ensure that all new documentation sections are correctly formatted and provide accurate information.
• Test the new collaboration features and submission workflows as described in the documentation.
• Validate that the new images and code samples are correctly displayed and functional in the documentation.

[github-actions]

PR Summary

This pull request introduces several enhancements and restructuring to the FAQ and documentation sections of the project. Key changes include:

1. Reorganization of FAQ Topics: The FAQ section has been restructured to provide a more organized and accessible format. Topics are now grouped by categories such as Access and Permissions, Model Workflows, Model Inventory and Activity, Model Documentation and Templates, Model Validation and Findings, Collaboration, Ongoing Monitoring and Reporting, Testing and Thresholds, Integrations and Support, and Data Handling and Privacy.

2. New FAQ Entries: Several new FAQ entries have been added, covering topics like model registration, customization of workflows, integration options, and data privacy policies.

3. Documentation Enhancements: The documentation now includes more detailed sections on collaboration features, submission for approval processes, and transition workflow examples. This aims to provide clearer guidance on using the platform's features effectively.

4. Code Samples and Notebooks: Updates to code samples and Jupyter notebooks have been made, including the addition of new examples for custom test implementations and image handling in test results.

5. Feedback Mechanism: A new feedback submission process has been integrated, allowing users to provide feedback directly from the platform.

These changes aim to improve user experience by making information more accessible and providing clearer guidance on using the platform's features.

Test Suggestions

• Verify that all FAQ links navigate to the correct sections and provide accurate information.
• Test the new feedback submission process to ensure it works as expected and captures user input correctly.
• Check the integration of new code samples in Jupyter notebooks for syntax errors and functionality.
• Ensure that the restructured documentation sections are logically organized and easy to navigate.
• Validate that the new FAQ entries provide comprehensive answers to common user questions.

[github-actions]

A PR preview is available: Preview URL

[nrichers]

LGTM! I trust you with my life. 🧗

[github-actions]

A PR preview is available: Preview URL