Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove the class="remove" sections, remove old page break navigation understanding #3299

Merged
merged 3 commits into from
Feb 1, 2024

Conversation

patrickhlauke
Copy link
Member

  • the <section class="remove"> parts in the understanding documents are confusing and redundant, since they get overwritten at publication time with the actual guideline text from the guidelines folder
  • the page break navigation understanding document was left over, even though the SC was removed

@patrickhlauke
Copy link
Member Author

@alastc possibly another one for @iadawn to consider

@alastc
Copy link
Contributor

alastc commented Aug 22, 2023

Hi Patrick,

The problem is that if we edit the understanding documents and preview them, there is no SC text included.

It is a pain keeping them synced, but I think we had more confusion from not having them included.

@patrickhlauke
Copy link
Member Author

patrickhlauke commented Sep 1, 2023

I think we had more confusion from not having them included

my experience has been the opposite...particularly when things do get out of sync, and you're working directly in the repo

now that initial work on devising the actual SC text has been completed, I suggest these are removed. and the previewing aspect should be reconsidered/reworked - there must be a cleaner way to provide previews automatically that doesn't involve manually keeping files in sync

@patrickhlauke
Copy link
Member Author

now that 2.2 is published, i'd still strongly push for this cleanup here to take place @iadawn as otherwise we once again run the risk of having outdated scraps of older wordings of SCs hang around in our repo

@iadawn iadawn merged commit 6858276 into main Feb 1, 2024
1 check passed
@iadawn
Copy link
Contributor

iadawn commented Feb 1, 2024

I am going to merge this in to remove the sections of content that are outdated. The question of how we deal with previews is separate I feel and can be picked up elsewhere

@patrickhlauke
Copy link
Member Author

wonderful, thanks @iadawn

@patrickhlauke patrickhlauke deleted the patrickhlauke-clean-2.2-understanding branch February 1, 2024 11:04
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.

None yet

3 participants