Skip to content

Restructure BAYS_AE - #141

Draft
DCEW wants to merge 20 commits into
mainfrom
restructure_FAs
Draft

DCEW wants to merge 20 commits into
mainfrom
restructure_FAs

Conversation

@DCEW

@DCEW DCEW commented Sep 3, 2026

Copy link
Copy Markdown
Collaborator

Second attempt on this PR taking into account previous comments

  • no icons in the TOC
  • limitations section last
  • tables that can be created from the CSVs have been (leaving the level/description one as MD since I don't think we use this elsewhere?)

Relates to #94
Closes #55

Previous PR is here - recreated entirely due to git issues.
Screenshot 2026-09-03 094926
Screenshot 2026-09-03 095235

@DCEW
DCEW requested a review from a team as a code owner September 3, 2026 08:50
@DCEW DCEW self-assigned this Sep 3, 2026
@DCEW DCEW changed the title Switch to CSVs of YAML tables to make filtering easier Restructure BAYS_AE and switch to CSVs of YAML tables to make filtering easier Sep 3, 2026

@yiwen-h yiwen-h left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Changing the format of three of our key reference files from YAML to CSV is a decision that needs wider discussion before it is enacted in a pull request.

If we change them to CSV we'll need to update the pages that refer to them, e.g. calculation-traceability-matrix.md, classification-register.md and conversion-archetypes-catalogue.md. As it stands, your PR will break these pages.

YAML is arguably a better format because of the structure of the data. I'm sure it is also possible to load and filter the data from YAML format as well as CSV. I can take a look into this if you would like.

Welcome thoughts from @paulseamer on the preferred file format for these reference files

@DCEW
DCEW marked this pull request as draft September 4, 2026 09:53
@DCEW
DCEW requested a review from StatsRhian September 7, 2026 08:05
@DCEW
DCEW marked this pull request as ready for review September 7, 2026 08:11
@DCEW DCEW changed the title Restructure BAYS_AE and switch to CSVs of YAML tables to make filtering easier Restructure BAYS_AE Sep 7, 2026
@yiwen-h

yiwen-h commented Sep 7, 2026

Copy link
Copy Markdown
Member

Your code references format_list_cells which is not yet in the repo so I can't run it locally - we need to get https://github.com/The-Strategy-Unit/open-plan-docs/compare/61-yaml-format in first

@DCEW

DCEW commented Sep 7, 2026

Copy link
Copy Markdown
Collaborator Author

Your code references format_list_cells which is not yet in the repo so I can't run it locally - we need to get https://github.com/The-Strategy-Unit/open-plan-docs/compare/61-yaml-format in first

Yes, I messaged Rhian about this as I can't render locally with Paul's formatting changes.

@yiwen-h

yiwen-h commented Sep 7, 2026

Copy link
Copy Markdown
Member

My other initial thoughts (not full code review yet):

We need to be more DRY as there are loads of these functional area pages - worth defining a function for loading and filtering the reference files that we can reuse for each of them? (This can be handled in a later issue/PR but worth considering before we start applying the changes in this specific PR to all the functional area pages)

The way the files are filtered
str.contains('|'.join(['MINOR', 'BAYS']) is not robust (what if we change the names or add new assumptions?) - better to list the specific assumptions to display on the page and name them directly. I think this is important to address in this PR and in all other functional area pages.

@DCEW
DCEW marked this pull request as draft September 7, 2026 15:50
@DCEW

DCEW commented Sep 11, 2026

Copy link
Copy Markdown
Collaborator Author

Ok, I've gone back and altered the code that renders the assumptions table to make it more programmatically derived - avoiding the more brittle approach from before.

Further DRYing out can be a focus for a future PR (I've made a new issue for it).

NB the diff also includes the incoming changes from PS as I had to rebase (I think that's why anyway).

@DCEW
DCEW marked this pull request as ready for review September 11, 2026 13:15
@DCEW
DCEW marked this pull request as draft September 14, 2026 16:26
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.

Remove "future enhancements" from the detailed Functional Areas page

3 participants