Add docs for metadata and Scenarios Framework#2
Merged
janmaarten-a11y merged 9 commits intomainfrom Sep 18, 2025
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds new documentation for the Annotation Toolkit, specifically focusing on metadata handling in web documents. The changes introduce comprehensive tutorials for language declaration and page title annotation, along with a brief explanation of the Scenarios Framework.
- Adds a detailed tutorial on metadata annotation with focus on language and page title elements
- Introduces documentation for the Scenarios Framework used within the Annotation Toolkit
- Provides comprehensive guidance on accessibility best practices for web document metadata
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 8 comments.
| File | Description |
|---|---|
| tutorials/metadata.md | Comprehensive tutorial covering language and page title metadata annotations with accessibility guidelines |
| basics/scenarios-framework.md | Brief documentation explaining the internal Scenarios Framework initiative |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Collaborator
|
Good job, 🤖. You found all my zero-width non-breaking spaces. Have a little merge as a treat! |
janmaarten-a11y
approved these changes
Sep 18, 2025
|
|
||
| Declare the language of the page, or parts of the page. | ||
|
|
||
| ### [Annotation Tiers](https://github.com/github/annotation-toolkit/blob/main/deep-dives/tiered-model.md) |
This comment was marked as off-topic.
This comment was marked as off-topic.
Sorry, something went wrong.
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
3 participants
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.
Adds a tutorial doc for metadata annotations and a guidance doc explaining the Scenarios Framework.