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

Chore: Tidy up some formatting on the pull request pages #942

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

huwd
Copy link
Member

@huwd huwd commented Oct 8, 2024

Conflating two things here (sorry was in a rush).

  1. Updating that One Login use Service now
  2. Whilst I was there amended the apostrophes to U+0027 chars, as I understand it follows best tech writer practice. Plus it's caused me some grief recently where I've had content that needs to compile through erb -> markdown -> html and something along the way has gotten confused about quote marks.

I believe this is in line with tech writer style guide, it certainly
caused my editor to get confused about what was code and where
pigmenting should start and stop.

No harm it seems to me in using a quote mark that is unambiguously
content and not code.
Our ticketing and support systems are becoming more complicated across
GDS, hopefully this is a minor clarification that avoids a double take
from folks not using zendesk
Copy link
Contributor

@louzoid-gds louzoid-gds left a comment

Choose a reason for hiding this comment

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

LGTM Huw thank you!
If this is a full review of the page, can you also update the review date?

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