Skip to content

Updated Swap Documentation Templates for Barclays#230

Merged
validbeck merged 6 commits intomainfrom
beck/sc-5129/update-swap-documentation-templates-for-barclays
Jun 26, 2024
Merged

Updated Swap Documentation Templates for Barclays#230
validbeck merged 6 commits intomainfrom
beck/sc-5129/update-swap-documentation-templates-for-barclays

Conversation

@validbeck
Copy link
Copy Markdown
Collaborator

Internal Notes for Reviewers

For sc-5129, I quickly edited and fleshed out swap-documentation-templates.qmd as this guide was slightly incomplete.

Intro

I cleaned up the intro and made sure it looked nice on the CTA summary.

  • The old intro was worded in such a way that implied you could make edits TO the template (rather than just switch the parent template), so hopefully that's been clarified in this version.
Old New
Screenshot 2024-06-26 at 11 46 33 AM Screenshot 2024-06-26 at 11 46 43 AM
Screenshot 2024-06-26 at 11 47 10 AM Screenshot 2024-06-26 at 11 47 17 AM

View current templates

This and the "Swap templates" section were missing the information about the Validation report option. Tweaked the styling to be consistent with our guide.

Old New
Screenshot 2024-06-26 at 11 47 56 AM Screenshot 2024-06-26 at 11 48 03 AM

Swap templates

Made some slight tweaks to the verbiage/styling and added a gif.

Old New
Screenshot 2024-06-26 at 11 50 04 AM Screenshot 2024-06-26 at 11 50 20 AM

Other comments

  • Added a quick "What's next" section as per our convention

When swapping templates, only the document structure is changed. Any modifications that you might have made to content is preserved inside each content block or section:

  • I'm sure I can stress-test this, but what happens to contents in blocks/sections that are removed from the template? 😬 (I assume they are also removed...)

@github-actions
Copy link
Copy Markdown
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.

@validbeck validbeck self-assigned this Jun 26, 2024
@validbeck validbeck added the internal Not to be externalized in the release notes label Jun 26, 2024
Copy link
Copy Markdown
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! Just some minor comments about verbiage and animated GIF placement.

@validbeck validbeck merged commit c9338d9 into main Jun 26, 2024
@validbeck validbeck deleted the beck/sc-5129/update-swap-documentation-templates-for-barclays branch June 26, 2024 20:31
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