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 link display #1778

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

Improve link display #1778

wants to merge 4 commits into from

Conversation

ndporter
Copy link
Contributor

@ndporter ndporter commented Jan 15, 2025

This PR is focused on improving the clarity and consistency of links across the instructor training, particularly when used in exercises that may be copied into etherpads (and thus not copy links without explicit text). Additional changes are listed below and generally connect to the legibility of links for both disabled and non-disabled users (including screen-reader software).

Changes:

  1. Replace [Linkname][url] [url][url] in exercises by adding the word at between linkname and URL to sound more natural but still provide information in an etherpad-friendly way
  2. Add periods where natural after sentence-ending links
  3. Adjust some formatting and caption for images to improve display and accessibility
  4. Adjust link text when large portions of a sentence are linked to reduce cognitive load from long link display
  5. Consolidated 2 versions of bad teaching video to only use one with multilingual captions (probably should have been a separate PR but I got carried away)
  6. Replace some quoted phrases with bolding for clarity
  7. Adjust line breaks in some places (remove old style line breaks when editing section, ensure lists are spaced correctly for md, etc)

Copy link

github-actions bot commented Jan 15, 2025

Thank you!

Thank you for your pull request 😃

🤖 This automated message can help you check the rendered files in your submission for clarity. If you have any questions, please feel free to open an issue in {sandpaper}.

If you have files that automatically render output (e.g. R Markdown), then you should check for the following:

  • 🎯 correct output
  • 🖼️ correct figures
  • ❓ new warnings
  • ‼️ new errors

Rendered Changes

🔍 Inspect the changes: https://github.com/carpentries/instructor-training/compare/md-outputs..md-outputs-PR-1778

The following changes were observed in the rendered markdown documents:

 01-welcome.md           |  27 +-
 02-practice-learning.md | 848 ++++++++++++++++++++++++++----------------------
 04-expertise.md         |   2 +-
 05-memory.md            |   4 +-
 06-feedback.md          |   4 +-
 08-motivation.md        |  12 +-
 09-eia.md               |  22 +-
 11-practice-teaching.md |  17 +-
 13-second-welcome.md    |   5 +-
 14-checkout.md          |   5 +-
 15-carpentries.md       |  33 +-
 17-live.md              |  32 +-
 20-performance.md       |  23 +-
 21-management.md        |  96 ++----
 23-introductions.md     |   2 +-
 25-wrap-up.md           |   2 +-
 md5sum.txt              |  32 +-
 17 files changed, 597 insertions(+), 569 deletions(-)
What does this mean?

If you have source files that require output and figures to be generated (e.g. R Markdown), then it is important to make sure the generated figures and output are reproducible.

This output provides a way for you to inspect the output in a diff-friendly manner so that it's easy to see the changes that occur due to new software versions or randomisation.

⏱️ Updated at 2025-01-15 15:16:51 +0000

@ndporter ndporter requested a review from a team January 15, 2025 15:16
github-actions bot pushed a commit that referenced this pull request Jan 15, 2025
@ndporter
Copy link
Contributor Author

Some review from @carpentries/core-team-curriculum and any relevant accessibility committee members (I don't know if there is a Git group for Carpentries accessibility) would also be appreciated.

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