Skip to content

Add alt text to all docs images #101

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

Merged
merged 5 commits into from
Jun 20, 2025

Conversation

stephen-ashby
Copy link
Contributor

@stephen-ashby stephen-ashby commented Jun 19, 2025

Summary

  • Add alt text for screenshots and inline icons across docs

Testing

  • git status --short

https://chatgpt.com/codex/tasks/task_b_68540b946ffc8326b4701e5271dd6e11

@stephen-ashby stephen-ashby changed the title Fix alt text wording in Lens guide Add alt text to all docs images Jun 19, 2025
Copy link
Contributor

@talagluck talagluck left a comment

Choose a reason for hiding this comment

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

Alright! Overall, Codex did a pretty good job here. There were a bunch of updates needed, though.

A few other things I found:

  • I identified (and noted) a bunch of pages that seem to be extraneous.
  • Some of the files (particularly the individual authenticated access guides) seem to have extra backslashes at the end of some paragraphs.
  • We also need to update a few of the authenticated access guides with updated screenshots to reflect the rename.
  • Should card images have alt text too?

Copy link
Contributor

Choose a reason for hiding this comment

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

I think this is no longer used? Looks like it redirects to https://gitbook.com/docs/collaboration/change-requests

Copy link
Contributor

Choose a reason for hiding this comment

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

I think this is also no longer used, and redirects to https://gitbook.com/docs/collaboration/live-edits

@@ -11,7 +11,7 @@ You can customize the appearance of your published documentation, match the user

You can apply customizations to your entire docs site as a site-wide theme, or to individual variants and site sections.

<figure><img src="../../.gitbook/assets/21_04_25_customization_published_site.svg" alt=""><figcaption><p>GitBook's own documentation is an example of a customized docs site.</p></figcaption></figure>
<figure><img src="../../.gitbook/assets/21_04_25_customization_published_site.svg" alt="A GitBook screenshot showing a customized docs site"><figcaption><p>GitBook's own documentation is an example of a customized docs site.</p></figcaption></figure>
Copy link
Contributor

Choose a reason for hiding this comment

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

We may want to update this screenshot to reflect our current docs.

Copy link
Contributor

Choose a reason for hiding this comment

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

These images have broken reference links (and this feature is deprecated anyway)

@stephen-ashby
Copy link
Contributor Author

@talagluck Thanks for the review! I’ve committed all your changes and a couple of others that you mentioned needed fixing. I haven’t fixed any of the more in-depth things (like pages that are no longer live or VA images that need replacing)

Let me know what you think and if we’re ready to merge!

@talagluck
Copy link
Contributor

@stephen-ashby then I think we should be good to merge!

Copy link
Contributor

@talagluck talagluck left a comment

Choose a reason for hiding this comment

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

lgtm

@stephen-ashby stephen-ashby merged commit 9098ed4 into main Jun 20, 2025
2 checks passed
@stephen-ashby stephen-ashby deleted the codex/add-alt-text-to-missing-images branch June 20, 2025 13:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants