Adds documentation and flowchart for update script refactor

[ChrisC]

Adding some additional documentation and a flowchart for the recent refactor for the update-bcd script that were made for @foolip while the changes were being reviewed. @foolip made the suggestion that this additional documentation may be useful to other maintainers and could possibly be added to the repo as well, so offering it here!

cc @mzgoddard

[queengooborg]

Thanks @ChrisC! I'll give a proper review later, but I think it would be nice to have the flowchart defined in Mermaid syntax, which GitHub natively supports, making it easier to modify the flowchart in the future if need be. Would you be down to make that change?

[ChrisC]

Thanks @ChrisC! I'll give a proper review later, but I think it would be nice to have the flowchart defined in Mermaid syntax, which GitHub natively supports, making it easier to modify the flowchart in the future if need be. Would you be down to make that change?

Appreciate the mermaid syntax suggestion @queengooborg ! Will look into it and implement the flowchart that way 👍🏽

[queengooborg]

A few nits!

[queengooborg]

Hey @ChrisC, just checking in to see if you plan on returning to this PR!

[ChrisC]

Hey @ChrisC, just checking in to see if you plan on returning to this PR!

I'm hoping to! Wasn't able to make the time for it the last few weeks, but hopefully can return to this in early March! Thanks for checking in 👍🏽

[queengooborg]

Sounds good! If you'd like, I'd be happy to tackle the requested changes and Mermaid conversion?

[ChrisC]

Yes if you have the bandwidth to tackle sooner, feel free to jump on it! 😄

[queengooborg]

Awesome! In that case, would you mind enabling maintainer editing permissions for this PR, if you're able to? That way, I can push to this PR!

[ChrisC]

Awesome! In that case, would you mind enabling maintainer editing permissions for this PR, if you're able to? That way, I can push to this PR!

Yes, let me just confirm that we can do that!

[ChrisC]

Ok @queengooborg you should have editing permissions now! Thanks again for offering to help close this out!

Changes have been applied

[queengooborg]

Thank you! Let's get this landed!