Skip to content

Documented ability to add attachment notes#495

Merged
validbeck merged 2 commits intomainfrom
beck/sc-6824/documentation-dev-add-ability-to-add-a-file
Oct 30, 2024
Merged

Documented ability to add attachment notes#495
validbeck merged 2 commits intomainfrom
beck/sc-6824/documentation-dev-add-ability-to-add-a-file

Conversation

@validbeck
Copy link
Copy Markdown
Collaborator

@validbeck validbeck commented Oct 25, 2024

Internal Notes for Reviewers

sc-6824

LIVE PREVIEW

@validbeck validbeck added the internal Not to be externalized in the release notes label Oct 25, 2024
@validbeck validbeck self-assigned this Oct 25, 2024
@validbeck
Copy link
Copy Markdown
Collaborator Author

Hey @lucaspazneutech, can you give these instructions a quick once-over to make sure they are accurate?

If they look good to you, pls approve 🙏🏻

@github-actions
Copy link
Copy Markdown
Contributor

PR Summary

This pull request refactors the documentation related to managing attachments in the model inventory and model validation guides. The changes introduce reusable content for adding and removing attachments, which is included in multiple documentation files to ensure consistency and reduce redundancy.

Key Changes:

  • Introduced _manage-supporting-documentation-add.qmd and _manage-supporting-documentation-remove.qmd files to centralize the instructions for adding and removing attachments.
  • Updated edit-model-inventory-fields.qmd and add-manage-model-findings.qmd to include the new centralized documentation files for managing attachments.
  • Added animated GIFs (add-attachment-note.gif and delete-attachments.gif) to visually demonstrate the processes of adding and removing attachments.

These changes aim to streamline the documentation process and ensure that updates to attachment management instructions are easily propagated across all relevant guides.

Test Suggestions

  • Verify that the included documentation files (_manage-supporting-documentation-add.qmd and _manage-supporting-documentation-remove.qmd) are correctly rendered in all referencing guides.
  • Check that the animated GIFs are displayed correctly and provide clear visual guidance.
  • Ensure that the links and references within the included documentation files are functional and accurate.
  • Test the documentation build process to confirm that the inclusion of external files does not introduce errors.

Copy link
Copy Markdown

@lucaspazneutech lucaspazneutech left a comment

Choose a reason for hiding this comment

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

All good here ✅

@validbeck validbeck merged commit c210452 into main Oct 30, 2024
@validbeck validbeck deleted the beck/sc-6824/documentation-dev-add-ability-to-add-a-file branch November 4, 2024 20:33
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