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

Improve HTML structure for additional guidance #581

Merged
merged 3 commits into from
Aug 7, 2023

Conversation

DavidBiddle
Copy link
Contributor

@DavidBiddle DavidBiddle commented Aug 4, 2023

What problem does this pull request solve?

Trello card: None but part of the detailed guidance work

Includes two tweaks to fix some invalid HTML:

  • Fixes an issue where <p> tags were being rendered inside <p> tags
  • customises the govuk-details component HTML so that we're not rendering a h2 inside a span

Also includes a change to make our markdown examples more semantic:

  • Wraps our markdown examples in pre and code tags as this is more semantically appropriate for code samples
    • includes some styling to make these look the same as they do now

Things to consider when reviewing

  • Does it work when run on your machine?
  • Is it clear what the code is doing?
  • Do the commit messages explain why the changes were made?
  • Are there all the unit tests needed?
  • Has all relevant documentation been updated?

@DavidBiddle DavidBiddle changed the title Guidance html improvements Improve HTML structure for additional guidance Aug 4, 2023
@DavidBiddle DavidBiddle marked this pull request as ready for review August 4, 2023 07:21
@DavidBiddle DavidBiddle requested a review from a team as a code owner August 4, 2023 07:21
@DavidBiddle DavidBiddle force-pushed the guidance-html-improvements branch from b420833 to 67f72b9 Compare August 4, 2023 07:58
@aliuk2012 aliuk2012 force-pushed the guidance-html-improvements branch from 67f72b9 to 8f65bc9 Compare August 7, 2023 07:36
@sonarqubecloud
Copy link

sonarqubecloud bot commented Aug 7, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@DavidBiddle DavidBiddle added this pull request to the merge queue Aug 7, 2023
Merged via the queue into main with commit 1b3417c Aug 7, 2023
@DavidBiddle DavidBiddle deleted the guidance-html-improvements branch August 7, 2023 07:58
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.

2 participants