Updated code snippets intro and image alt #876
Open
dessyordanova wants to merge 7 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates WinForms documentation pages to improve accessibility and clarity by adding/strengthening image alt text and adding explicit caption/intro text around code snippets and screenshots, focusing on highly visited articles.
Changes:
- Added descriptive alt text for previously uncaptioned images across multiple docs pages.
- Added explicit bold captions / introductions before certain code snippets and screenshots.
- Adjusted a few “related videos”/figure presentation blocks to align with updated image descriptions.
Reviewed changes
Copilot reviewed 56 out of 56 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| telerik-presentation-framework/html-like-text-formatting.md | Improves image alt text and adds a bold caption for a code snippet screenshot. |
| licensing/add-license-to-ci-cd.md | Adds alt text to Azure DevOps pipeline task screenshots. |
| knowledge-base/use-custom-filtering-to-search-in-radmulticolumncombobox.md | Adds alt text to the example screenshot. |
| knowledge-base/unable-to-build-project-after-upgrade.md | Adds alt text to a Control Panel Help screenshot. |
| knowledge-base/showing-hiding-elements-in-telerik-radcontrols.md | Adds alt text to multiple RadRibbonBar visibility screenshots. |
| knowledge-base/ribbonbar-dragdrop-treeview.md | Adds alt text to a drag-and-drop animated image. |
| knowledge-base/ribbonbar-design-time-exception.md | Adds alt text to a designer hierarchy screenshot. |
| knowledge-base/ribbonbar-add-watermark.md | Adds alt text to a watermark animated image. |
| knowledge-base/radscheduler-with-multiple-resources.md | Adds alt text to a RadScheduler dialog screenshot. |
| knowledge-base/radpageview---create-multiline-strip-element-with-radcommandbar.md | Adds alt text to two RadPageView/RadCommandBar screenshots. |
| knowledge-base/radcontrols-for-winforms-are-not-loaded-at-design-time.md | Adds alt text to a Visual Studio component tray screenshot. |
| knowledge-base/radchartview-drag-and-drop.md | Adds alt text to a RadChartView drag-and-drop animated image. |
| knowledge-base/performance-boots-with-virtual-radmulticolumncombobox.md | Adds alt text to a Solution Explorer screenshot. |
| knowledge-base/mutiselect-drop-down-list-column-in-radgridview.md | Adds alt text to a RadGridView custom column screenshot. |
| knowledge-base/mixing-default-and-custom-sorting-in-multisort-scenario.md | Adds alt text to a sorting example screenshot. |
| knowledge-base/load-theme-components-in-a-separate-thread.md | Adds alt text to a theme-loaded screenshot. |
| knowledge-base/implementing-custom-editor-for-radtreenode.md | Adds alt text to a sequence of RadTreeView editor screenshots. |
| knowledge-base/gridview-with-visible-summary-cells-in-a-collapsed-group.md | Adds alt text to a collapsed group summary screenshot. |
| knowledge-base/get-clicked-image-coordinates.md | Adds alt text to a RadImageEditor coordinates animated image. |
| knowledge-base/failed-to-create-component-design-time-exception.md | Adds alt text to a Visual Studio designer error dialog screenshot. |
| knowledge-base/docking-controls-on-a-form-in-a-windows-forms-application.md | Adds alt text to multiple docking-order screenshots. |
| knowledge-base/distinguishing-between-versions-dev-trial.md | Adds alt text to several trial-vs-dev identification screenshots. |
| knowledge-base/customize-header-checkbox-behavior.md | Adds alt text to a header-checkbox behavior animated image. |
| knowledge-base/customize_command_column.md | Adds alt text to a command column customization screenshot. |
| knowledge-base/create-pop-up-user-control-for-row-editing.md | Adds alt text to a RadGridView row-editing popup screenshot. |
| knowledge-base/create-password-textbox.md | Adds alt text to a password textbox animated image. |
| knowledge-base/could-not-load-file-or-assembly-telerik-wincontrols-xmlserializers.md | Adds alt text to Fusion Log / Exceptions dialog screenshots. |
| knowledge-base/copy-paste-displaymember-for-gridviewcomboboxcolumn.md | Replaces a malformed heading+image construct with a proper image + alt text. |
| knowledge-base/chartview-sine-wave.md | Adds alt text to a sine-wave chart screenshot. |
| knowledge-base/chartview-offset-pie-legend.md | Adds alt text to an offset pie legend animated image. |
| knowledge-base/chartview-legend-reverse.md | Adds alt text to a reversed legend order screenshot. |
| knowledge-base/chart-style-bars.md | Adds alt text to a styled bar chart screenshot. |
| knowledge-base/binding-to-a-result-of-query.md | Adds alt text to side-by-side data binding result screenshots. |
| knowledge-base/adding-custom-elements-inside-a-cell-when-it-is-in-edit-mode.md | Adds alt text to a custom editor screenshot. |
| installation-and-upgrades/api-analyzer.md | Adds alt text to screenshots and changes figure caption formatting. |
| controls/richtexteditor/getting-started/getting-started.md | Adds bold captions and improves alt text for getting-started screenshots. |
| controls/listview/custom-items.md | Improves alt text for custom visual item screenshots. |
| controls/gridview/visual-elements/rows/summary-rows.md | Improves alt text and adds bold captions for grouped/collapsed summary examples. |
| controls/gridview/visual-elements/rows/adding-and-inserting-rows.md | Improves alt text for add/insert row screenshots. |
| controls/gridview/visual-elements/columns/column-types/gridviewcomboboxcolumn.md | Improves alt text for GridViewComboBoxColumn screenshots. |
| controls/gridview/visual-elements/columns/column-types/gridviewcheckboxcolumn.md | Adds a bold caption and improves alt text for header checkbox examples. |
| controls/gridview/visual-elements/cells/formatting-cells.md | Improves alt text for tutorial thumbnails and formatting screenshots. |
| controls/gridview/view-definitions/column-groups-view.md | Improves alt text and normalizes snippet indentation. |
| controls/gridview/overview.md | Improves alt text for the webinar thumbnail and cleans up the related videos table. |
| controls/gridview/hierarchical-grid/binding-to-hierarchical-data-programmatically.md | Improves alt text and adds bold captions around hierarchy screenshots. |
| controls/gridview/getting-started.md | Improves alt text and adjusts image placement/indentation inside the step list. |
| controls/gridview/features/grouping/setting-groups-programmatically.md | Adds bold captions and improves alt text for grouping screenshots. |
| controls/gridview/features/grouping/basic-grouping.md | Adds a bold caption and improves alt text for scrollbar comparison screenshots. |
| controls/gridview/features/filtering/basic-filtering.md | Improves alt text and adds a bold caption for the filter box screenshot. |
| controls/gridview/features/exporting-data/spread-export.md | Improves alt text and adds bold captions for export screenshots and examples. |
| cloud-integration/google-cloud/translation.md | Adds alt text to Google Cloud Translation tutorial screenshots. |
| cloud-integration/google-cloud/overview.md | Adds alt text to the Google Cloud overview image. |
| cloud-integration/google-cloud/datastore-nosql.md | Adds alt text to Cloud Datastore tutorial screenshots. |
| cloud-integration/azure/connect-to-data-in-the-cloud/sql-database.md | Adds alt text to Azure SQL tutorial screenshots. |
| cloud-integration/azure/cognitive-services/text-analysis.md | Adds alt text to Text Analytics tutorial screenshots. |
| cloud-integration/azure/cognitive-services/image-analysis.md | Adds alt text to Computer Vision tutorial screenshots. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The top 100 visited articles for the past 6 months have been prioritized according to the presence of code snippets. Most of the code snippets already had relevant local introductions through the surrounding sentences and headings. Several code snippet introductions were necessary to add. All images without alt text have been identified and a comprehensive text has been added. Some screenshots needed stronger alt text, and a few uncapted examples needed explicit bold captions.
Task 1: Introduce each code snippet with a descriptive sentence or with a caption. In case of an existing introduction sentence to the code snippet or a caption, do not update it and preserve the existing one. When implementing a caption, stick to the following styling and formatting rules:
Task 2: Check for the existence of effective alt text for images in the documentation, include the framework, component (if applicable), and the feature or functionality shown in the image. If the alt text is missing, write the alt text that should be descriptive and meaningful, helping both SEO and users who rely on screen readers. For example, use [Kendo UI for jQuery Grid Popup Editor] as alt text for an image showing that feature. In Markdown, enclose the alt text in square brackets before the image path. Always ensure the alt text accurately describes what is displayed, such as the type of chart, the data categories, or the UI elements highlighted