Visitar URL original
docs: fix README typo, placeholder alt text, and GitHub capitalization by devon-23 · Pull Request #358 · nasa/hermes · GitHub
Skip to content

docs: fix README typo, placeholder alt text, and GitHub capitalization - #358

Open
devon-23 wants to merge 1 commit into
nasa:mainfrom
devon-23:docs/readme-fixes
Open

devon-23 wants to merge 1 commit into
nasa:mainfrom
devon-23:docs/readme-fixes

Conversation

@devon-23

Copy link
Copy Markdown
  • 'read out' -> 'read our' in the Quick Start sentence
  • Replace the placeholder 'alt text' on the main screenshot with a description of what it shows (WCAG 2.1 1.1.1)
  • 'Github' -> 'GitHub'
    further ::

Three small README fixes.

Typo. Line 17 reads "We encourage new users to read out [Quick Start] guide" — should be "read our".

Placeholder alt text. Line 11 is alt text — the default placeholder, on the project's main screenshot. Replaced with a description of what the image actually shows: the VS Code extension with a command procedure notebook, telemetry table, telemetry plot, and F Prime source. This is what screen readers announce, and what appears if the image fails to load (WCAG 2.1 1.1.1).

Happy to reword the description if it doesn't match how you'd characterize the screenshot.

Capitalization. "Github" → "GitHub" on line 15.

1 file, 3 insertions, 3 deletions.

- 'read out' -> 'read our' in the Quick Start sentence
- Replace the placeholder 'alt text' on the main screenshot with a
  description of what it shows (WCAG 2.1 1.1.1)
- 'Github' -> 'GitHub'

This branch has not been deployed

No deployments
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.

1 participant