Skip to content

Reorganization of best practices and addition of overlays for globals - #201

Open
baywet wants to merge 10 commits into
OAI:mainfrom
baywet:feat/patterns-and-pratices
Open

baywet wants to merge 10 commits into
OAI:mainfrom
baywet:feat/patterns-and-pratices

Conversation

@baywet

@baywet baywet commented Apr 9, 2026 •

Copy link
Copy Markdown
Member

fixes #200
This does a couple of things:

  • Makes the best practices into a section
  • Moves the topics under best practices to dedicated pages (verbatim, no changes were made besides links)
  • Adds a new best practice to use overlays for globals

Heavy use of GH Copilot to help with the reorganization and the wording

@baywet
baywet enabled auto-merge April 9, 2026 17:41
@baywet baywet changed the title feat/patterns and pratices Reorganization of best practices and addition of overlays for globals Apr 9, 2026
Signed-off-by: Vincent Biret <vincentbiret@hotmail.com>

@lornajane lornajane left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I love this! And sorry, I added loads of comments, should I have just edited? I know half of this isn't yours. The Overlays for global updates is great!

Comment thread best-practices/index.md
Comment thread best-practices/describing-large-apis.md
Comment thread best-practices/index.md
Comment thread best-practices/index.md
Comment thread best-practices/index.md
Comment thread best-practices/use-a-design-first-approach.md
Comment thread best-practices/use-overlays-for-global-information.md Outdated
Comment thread best-practices/use-overlays-for-global-information.md Outdated
baywet and others added 3 commits April 13, 2026 07:19
Co-authored-by: Lorna Jane Mitchell <github@lornajane.net>
Co-authored-by: Lorna Jane Mitchell <github@lornajane.net>
Signed-off-by: Vincent Biret <vincentbiret@hotmail.com>
@baywet

baywet commented Apr 13, 2026

Copy link
Copy Markdown
Member Author

@lornajane thanks for the review. I have "moved" the feedback on existing content to #203. I don't think we should address it here since:

  • it was already published
  • it'll make the review process lengthier
  • it's a verbatim move of the existing content, I didn't change anything (other than adding the overlay one)

Let me know if you still have suggestions on the overlay article, otherwise we should be good to merge as is and follow up with another PR to address the concerns you had on existing content.

@baywet
baywet requested a review from lornajane April 13, 2026 11:47
@lornajane

Copy link
Copy Markdown
Contributor

This makes sense. Let's work on the restructure so we've got somewhere to land this article!

@baywet

baywet commented Apr 27, 2026

Copy link
Copy Markdown
Member Author

@lornajane let me know if you have any additional feedback specific to this new article. Otherwise it's ready for another review.

Comment thread best-practices/describing-large-apis.md Outdated
Comment thread best-practices/describing-large-apis.md Outdated
Comment thread best-pratices/use-overlays-to-add-common-entries.md Outdated
baywet and others added 2 commits July 24, 2026 14:28
Co-authored-by: Karen Etheridge <github@froods.org>
Co-authored-by: Vincent Biret <vincentbiret@hotmail.com>
@baywet
baywet requested a review from karenetheridge July 24, 2026 18:32

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Patterns and practices - Overlay for globals

3 participants