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

Clean up formatting and tweak wording in UI documentation #72462

Merged

Conversation

ZeroInternalReflection
Copy link
Contributor

Summary

None

Purpose of change

#72344 expanded the documentation on how screen readers interact with UI screens in-game, and provided several diagrams of what can go wrong and how to fix it. However, I forgot to check how those diagrams looked in markdown format rather than just in a text editor. So, what was supposed to look like this:

-----------------------------------------------------
|Choose type of butchery:                           |
|---------------------------------------------------|
XB Quick butchery	6 minutes                   |
|b Full butchery	39 minutes                  |
|---------------------------------------------------|
|This technique is used when you are in a hurry, but|
|still want to harvest something from the corpse.   |
-----------------------------------------------------

Ended up looking like this:
Screenshot from 2024-03-17 15-53-00

Screenshot from 2024-03-17 15-53-04

Describe the solution

Enclose the diagrams in markdown code blocks ("```")
Tweak some other formatting/wording from #72344 for clarity.

Describe alternatives you've considered

Testing

Drop the proposed changes into a gist in .md format to see if it works. Double-check by going to "View File" on the document in the PR.

Additional context

@github-actions github-actions bot added <Documentation> Design documents, internal info, guides and help. [Markdown] Markdown issues and PRs astyled astyled PR, label is assigned by github actions json-styled JSON lint passed, label assigned by github actions BasicBuildPassed This PR builds correctly, label assigned by github actions labels Mar 17, 2024
@kevingranade kevingranade merged commit 200f806 into CleverRaven:master Mar 20, 2024
15 of 20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
astyled astyled PR, label is assigned by github actions BasicBuildPassed This PR builds correctly, label assigned by github actions <Documentation> Design documents, internal info, guides and help. json-styled JSON lint passed, label assigned by github actions [Markdown] Markdown issues and PRs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants