Skip to content

Commit 9098ed4

Browse files
Merge pull request #101 from GitbookIO/codex/add-alt-text-to-missing-images
Add alt text to all docs images
2 parents dd3c13b + f223ac2 commit 9098ed4

File tree

75 files changed

+192
-192
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

75 files changed

+192
-192
lines changed

account-management/account-settings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: View and manage the settings for your personal GitBook account.
77

88
You can manage your login details, third-party login options, GitBook subdomain, interface theme, notification, integrations and API access tokens.
99

10-
<figure><img src="../.gitbook/assets/10_01_25_account_settings.svg" alt=""><figcaption><p>Your personal settings page.</p></figcaption></figure>
10+
<figure><img src="../.gitbook/assets/10_01_25_account_settings.svg" alt="A GitBook screenshot showing the personal settings page" ><figcaption><p>Your personal settings page.</p></figcaption></figure>
1111

1212
### How to access your personal account settings
1313

account-management/billing-faq/cancelling-a-plan.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Only administrators can access an organization’s billing settings to cancel a
99

1010
If your mind is made up, here’s how to cancel your plan:
1111

12-
1. Go to the organization’s settings page. You can click on the settings <img src="../../.gitbook/assets/settings.png" alt="" data-size="line"> icon at the bottom of the sidebar and then click on **\[organization name] settings** to get there.
12+
1. Go to the organization’s settings page. You can click on the settings <img src="../../.gitbook/assets/settings.png" alt="The settings icon in GitBook" data-size="line"> icon at the bottom of the sidebar and then click on **\[organization name] settings** to get there.
1313
2. Click on the **billing** tab. This will take you to a billing page hosted on Stripe, our payment processor.
1414

1515
<div data-full-width="true">

account-management/cancelling-a-plan.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Here’s how to cancel your plan:
1111

1212
1. Go to the organization’s settings page. You can click on the settings&#x20;
1313

14-
<picture><source srcset="../.gitbook/assets/settings_icon_dark.svg" media="(prefers-color-scheme: dark)"><img src="../.gitbook/assets/settings_icon_light.svg" alt=""></picture>
14+
<picture><source srcset="../.gitbook/assets/settings_icon_dark.svg" media="(prefers-color-scheme: dark)"><img src="../.gitbook/assets/settings_icon_light.svg" alt="The Settings icon in GitBook"></picture>
1515

1616
&#x20;icon at the bottom of the sidebar and then click on **\[organization name] settings** to get there.
1717
2. Click on the **billing** tab. This will take you to a billing page hosted on Stripe, our payment processor.

account-management/organization-settings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ icon: sitemap
66

77
View and manage the settings for your GitBook organization. These include member management, sign-in methods, integrations, billing and plans.
88

9-
<figure><img src="../.gitbook/assets/10_01_25_organization_settings.svg" alt=""><figcaption><p>Your organization settings page.</p></figcaption></figure>
9+
<figure><img src="../.gitbook/assets/10_01_25_organization_settings.svg" alt="A GitBook screenshot showing the organization settings page" ><figcaption><p>Your organization settings page.</p></figcaption></figure>
1010

1111
### How to access the settings for an organization
1212

account-management/plans/community/sponsored-site-plan.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ description: >-
1010
This site plan is only available to users on our [community plan](./).
1111
{% endhint %}
1212

13-
<figure><img src="../../../.gitbook/assets/10_01_25_sponsored_site_plan_hero.svg" alt=""><figcaption><p>Learn more about the sponsored site plan in GitBook.</p></figcaption></figure>
13+
<figure><img src="../../../.gitbook/assets/10_01_25_sponsored_site_plan_hero.svg" alt="A GitBook screenshot showing the sponsored site plan hero section" ><figcaption><p>Learn more about the sponsored site plan in GitBook.</p></figcaption></figure>
1414

1515
The sponsored site plan lets you access all of GitBook’s best docs site features at no cost while displaying a small, relevant ad in the corner of your documentation site. Each view generates revenue for you, turning your documentation into a source of income.
1616

account-management/sso-and-saml/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ When you create or manage your organisation, you can add a list of email domains
1313

1414
You can enable email domain SSO in the ’SSO’ section of your organization settings; enter a comma-separated list of email domains you’d like to allow SSO access for and you’re good to go.
1515

16-
<figure><img src="../../.gitbook/assets/10_01_25_sso.svg" alt=""><figcaption><p>Set up SSO for your organization.</p></figcaption></figure>
16+
<figure><img src="../../.gitbook/assets/10_01_25_sso.svg" alt="A GitBook screenshot showing how to configure SSO" ><figcaption><p>Set up SSO for your organization.</p></figcaption></figure>
1717

1818
{% hint style="info" %}
1919
Anyone who joins via an SSO email domain will default to guest access, you can change their role at any time in the members section of your organization settings.

api-references/openapi/add-an-openapi-specification.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ description: >-
88

99
If you have an OpenAPI spec, you can add it to your organization by uploading the file directly, linking to a hosted URL, or using the [GitBook CLI](broken-reference).
1010

11-
<figure><img src="../../.gitbook/assets/02_04_25_add_api_spec.svg" alt=""><figcaption></figcaption></figure>
11+
<figure><img src="../../.gitbook/assets/02_04_25_add_api_spec.svg" alt="A GitBook screenshot showing the modal for generating API docs automatically" ><figcaption></figcaption></figure>
1212

1313
### How to add a specification
1414

@@ -20,7 +20,7 @@ If you have an OpenAPI spec, you can add it to your organization by uploading th
2020
* Enter a URL to a hosted spec
2121
* Use the CLI to publish the spec
2222

23-
<figure><img src="../../.gitbook/assets/03_04_25_api_spec_modal (1).svg" alt=""><figcaption><p>Add an OpenAPI specification modal.</p></figcaption></figure>
23+
<figure><img src="../../.gitbook/assets/03_04_25_api_spec_modal (1).svg" alt="A GitBook screenshot showing the Add an OpenAPI specification modal"><figcaption><p>Add an OpenAPI specification modal.</p></figcaption></figure>
2424

2525
### Update your specification
2626

api-references/openapi/insert-api-reference-in-your-docs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Endpoints added from your spec will continue to be updated anytime your spec is
1616

1717
After you’ve [added your OpenAPI spec](add-an-openapi-specification.md), you can generate endpoint pages by inserting an **OpenAPI Reference** in the table of contents of a Space.
1818

19-
<figure><img src="../../.gitbook/assets/03_04_25_create_api_pages.svg" alt=""><figcaption><p>Insert API References in the table of contents of a Space.</p></figcaption></figure>
19+
<figure><img src="../../.gitbook/assets/03_04_25_create_api_pages.svg" alt="A GitBook screenshot showing how to insert API references into the table of contents of a space" ><figcaption><p>Insert API References in the table of contents of a Space.</p></figcaption></figure>
2020

2121
{% stepper %}
2222
{% step %}

collaboration/change-requests.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ A change request is a copy of your main content. It comes from the simple concep
99

1010
In a change request, you can edit, update and delete elements of your content, request reviews on your changes, then merge them back into your main version to apply all the changes you made.
1111

12-
<figure><img src="../.gitbook/assets/10_01_25_change_requests.svg" alt=""><figcaption><p>Edit your content through change requests.</p></figcaption></figure>
12+
<figure><img src="../.gitbook/assets/10_01_25_change_requests.svg" alt="A GitBook screenshot showing the change requests panel" ><figcaption><p>Edit your content through change requests.</p></figcaption></figure>
1313

1414
### Creating a change request
1515

@@ -120,4 +120,4 @@ If you don’t want to choose between versions, you can resolve a merge conflict
120120
121121
If you decide not to merge a change request and want to remove it from the queue, you can archive it.
122122
123-
To archive a change request, first open it up. Then click the **Actions menu** <picture><source srcset="../.gitbook/assets/actions-horizontal - dark.svg" media="(prefers-color-scheme: dark)"><img src="../.gitbook/assets/actions-horizontal.svg" alt=""></picture> next to the change request’s title and choose **Archive**. You can find and reopen archived change requests later by opening the **Change Requests** menu and selecting the **Archived** tab.
123+
To archive a change request, first open it up. Then click the **Actions menu** <picture><source srcset="../.gitbook/assets/actions-horizontal - dark.svg" media="(prefers-color-scheme: dark)"><img src="../.gitbook/assets/actions-horizontal.svg" alt="The Actions menu icon in GitBook"></picture> next to the change request’s title and choose **Archive**. You can find and reopen archived change requests later by opening the **Change Requests** menu and selecting the **Archived** tab.

collaboration/collaboration/change-requests.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: Learn about editing with change requests
66

77
<div data-full-width="true">
88

9-
<figure><img src="../../.gitbook/assets/Change requests collab.png" alt=""><figcaption><p>The change requests panel</p></figcaption></figure>
9+
<figure><img src="../../.gitbook/assets/Change requests collab.png" alt="A GitBook screenshot showing the change requests panel" ><figcaption><p>The change requests panel</p></figcaption></figure>
1010

1111
</div>
1212

@@ -26,7 +26,7 @@ In a space that is **locked** for live edits, hit the ’Edit’ button in the s
2626

2727
<div data-full-width="true">
2828

29-
<figure><img src="../../.gitbook/assets/start a change request.png" alt=""><figcaption><p>Click the "Edit" button in the top right corner to start a change request</p></figcaption></figure>
29+
<figure><img src="../../.gitbook/assets/start a change request.png" alt="A GitBook screenshot showing how to start a change request" ><figcaption><p>Click the "Edit" button in the top right corner to start a change request</p></figcaption></figure>
3030

3131
</div>
3232

@@ -42,7 +42,7 @@ Once you’re happy with your changes, you can **submit** the change request.
4242

4343
<div data-full-width="true">
4444

45-
<figure><img src="../../.gitbook/assets/submit for review.png" alt=""><figcaption><p>Submit your change request for review in the bottom right corner of the editor</p></figcaption></figure>
45+
<figure><img src="../../.gitbook/assets/submit for review.png" alt="A GitBook screenshot showing the submit for review button" ><figcaption><p>Submit your change request for review in the bottom right corner of the editor</p></figcaption></figure>
4646

4747
</div>
4848

collaboration/collaboration/live-edits.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ You can lock or unlock space for live edits by selecting ’Unlock live edits’
2626

2727
<div data-full-width="true">
2828

29-
<figure><img src="../../.gitbook/assets/Unlock live edits.png" alt=""><figcaption><p>Unlock live edits from the space actions menu</p></figcaption></figure>
29+
<figure><img src="../../.gitbook/assets/Unlock live edits.png" alt="A GitBook screenshot showing the Unlock live edits option" ><figcaption><p>Unlock live edits from the space actions menu</p></figcaption></figure>
3030

3131
</div>
3232

collaboration/comments.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Comments allow you to provide feedback around specific pieces of content — wit
99

1010
### Add a comment <a href="#comment-within-your-content" id="comment-within-your-content"></a>
1111

12-
You can open the comments panel by clicking on the **Comments** button <picture><source srcset="../.gitbook/assets/comment_icon_dark.svg" media="(prefers-color-scheme: dark)"><img src="../.gitbook/assets/comment_icon_light.svg" alt=""></picture> in the [space header](../resources/gitbook-ui.md#space-header).
12+
You can open the comments panel by clicking on the **Comments** button <picture><source srcset="../.gitbook/assets/comment_icon_dark.svg" media="(prefers-color-scheme: dark)"><img src="../.gitbook/assets/comment_icon_light.svg" alt="The Comments button icon in GitBook"></picture> in the [space header](../resources/gitbook-ui.md#space-header).
1313

1414
Adding a comment here will attach a comment to the entire page. You can also comment on a specific block by hovering over a block and clicking the content icon that appears on the right.
1515

collaboration/live-edits.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ GitBook supports live collaboration, meaning you’ll be able to work on the sam
1313

1414
### Toggling live edit mode
1515

16-
You can toggle live edit mode in a space by selecting **Lock live edits** or **Unlock live edits** from the [space header’s](../resources/gitbook-ui.md#space-header) **Actions menu** <picture><source srcset="../.gitbook/assets/actions-horizontal - dark.svg" media="(prefers-color-scheme: dark)"><img src="../.gitbook/assets/actions-horizontal.svg" alt=""></picture>.&#x20;
16+
You can toggle live edit mode in a space by selecting **Lock live edits** or **Unlock live edits** from the [space header’s](../resources/gitbook-ui.md#space-header) **Actions menu** <picture><source srcset="../.gitbook/assets/actions-horizontal - dark.svg" media="(prefers-color-scheme: dark)"><img src="../.gitbook/assets/actions-horizontal.svg" alt="The Actions menu icon in GitBook"></picture>.&#x20;
1717

1818
When a space is in **Live edits** mode, the space header will show the **Editor** tab. When it is in **Locked live edits** mode, the space header will show a **Read-only** tab. When the Read-only tab appears in the space header, you will need to open a change request to edit the content of the page.
1919

collaboration/pdf-export.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,14 @@ Note that links across spaces are not currently supported when exporting interna
2323

2424
#### Export an individual page
2525

26-
1. Open the page you want to export, then open the page’s [Actions menu](../resources/gitbook-ui.md#the-actions-menu) <picture><source srcset="../.gitbook/assets/actions_icon_dark.svg" media="(prefers-color-scheme: dark)"><img src="../.gitbook/assets/actions_icon_light.svg" alt=""></picture> next to the page title.
26+
1. Open the page you want to export, then open the page’s [Actions menu](../resources/gitbook-ui.md#the-actions-menu) <picture><source srcset="../.gitbook/assets/actions_icon_dark.svg" media="(prefers-color-scheme: dark)"><img src="../.gitbook/assets/actions_icon_light.svg" alt="The Actions menu icon in GitBook"></picture> next to the page title.
2727
2. Select **Export to PDF > Current page**.
2828
3. Wait for the page to load, then click the **Print or save as PDF** button in the upper right to open your browsers Print menu.
2929
4. From here, you can save the page as a PDF or open it in your PDF viewer using the typical process for your browser.
3030

3131
#### Export an entire space
3232

33-
1. Open the[ Actions menu](../creating-content/content-structure/) <picture><source srcset="../.gitbook/assets/actions_icon_dark.svg" media="(prefers-color-scheme: dark)"><img src="../.gitbook/assets/actions_icon_light.svg" alt=""></picture> next to the page title and choose **Export as PDF > All pages**. Alternatively, open the space’s **Actions menu** <picture><source srcset="../.gitbook/assets/actions-horizontal - dark.svg" media="(prefers-color-scheme: dark)"><img src="../.gitbook/assets/actions-horizontal.svg" alt=""></picture> in the [space header](../resources/gitbook-ui.md#space-header) and choose **Export as PDF** in the drop-down menu.\
33+
1. Open the[ Actions menu](../creating-content/content-structure/) <picture><source srcset="../.gitbook/assets/actions_icon_dark.svg" media="(prefers-color-scheme: dark)"><img src="../.gitbook/assets/actions_icon_light.svg" alt="The Actions menu icon in GitBook"></picture> next to the page title and choose **Export as PDF > All pages**. Alternatively, open the space’s **Actions menu** <picture><source srcset="../.gitbook/assets/actions-horizontal - dark.svg" media="(prefers-color-scheme: dark)"><img src="../.gitbook/assets/actions-horizontal.svg" alt="The Actions menu icon in GitBook"></picture> in the [space header](../resources/gitbook-ui.md#space-header) and choose **Export as PDF** in the drop-down menu.\
3434
\
3535
&#xNAN;_&#x4E;ote: This action is not available within a change request._
3636
2. Wait for the page to load, then click the **Print or save as PDF** button in the upper right to open your browsers Print menu.

collaboration/share.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Collaborate with your teammates on spaces, collections and more
55

66
# Inviting your team
77

8-
<figure><img src="../.gitbook/assets/10_01_25_invite_team.svg" alt=""><figcaption><p>Invite your team to GitBook to collaborate on pages, spaces, and published sites.</p></figcaption></figure>
8+
<figure><img src="../.gitbook/assets/10_01_25_invite_team.svg" alt="A GitBook screenshot showing the invite team dialog" ><figcaption><p>Invite your team to GitBook to collaborate on pages, spaces, and published sites.</p></figcaption></figure>
99

1010
### Sharing a space or collection
1111

@@ -45,4 +45,4 @@ If you don’t want to use email to invite someone to your content, or want to i
4545

4646
When you share this link, anyone who clicks on it will be able to sign up, join your organization as a [guest](../account-management/member-management/roles.md#guest-role), and get access to just this single space and its content.&#x20;
4747

48-
You can revoke the link at any time by opening the **Actions menu** <picture><source srcset="../.gitbook/assets/actions_icon_dark.svg" media="(prefers-color-scheme: dark)"><img src="../.gitbook/assets/actions_icon_light.svg" alt=""></picture> next to the link and choosing **Revoke**.
48+
You can revoke the link at any time by opening the **Actions menu** <picture><source srcset="../.gitbook/assets/actions_icon_dark.svg" media="(prefers-color-scheme: dark)"><img src="../.gitbook/assets/actions_icon_light.svg" alt="The Actions menu icon in GitBook"></picture> next to the link and choosing **Revoke**.

creating-content/blocks/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ icon: square-dashed-circle-plus
77

88
GitBook is a block-based editor, meaning you can add different kinds of blocks to your content — from standard text and images to interactive blocks. Your pages can include any combination of blocks you want, and there’s no limit to the number of blocks you can have on a page.
99

10-
<figure><img src="../../.gitbook/assets/10_01_25_content_blocks.svg" alt=""><figcaption><p>GitBook's built in content blocks.</p></figcaption></figure>
10+
<figure><img src="../../.gitbook/assets/10_01_25_content_blocks.svg" alt="A GitBook screenshot showing the available content blocks" ><figcaption><p>GitBook's built in content blocks.</p></figcaption></figure>
1111

1212
### Inserting a new content block
1313

@@ -41,7 +41,7 @@ Once selected, you can:
4141

4242
By making your blocks full width, you can create a clear visual hierarchy in your content, or simply give more space to content that needs it.
4343

44-
To make a block full width, click on the **Options menu** <picture><source srcset="../../.gitbook/assets/options_menu_icon_dark.svg" media="(prefers-color-scheme: dark)"><img src="../../.gitbook/assets/options_menu_icon_light.svg" alt=""></picture> next to your block and select **Full width**. This feature is available for the following block types:
44+
To make a block full width, click on the **Options menu** <picture><source srcset="../../.gitbook/assets/options_menu_icon_dark.svg" media="(prefers-color-scheme: dark)"><img src="../../.gitbook/assets/options_menu_icon_light.svg" alt="The Options menu icon in GitBook"></picture> next to your block and select **Full width**. This feature is available for the following block types:
4545

4646
* Code Blocks
4747
* Image blocks

0 commit comments

Comments
 (0)