Skip to content

Add image description text for the audio splice rendering image#366

Open
chrisn wants to merge 2 commits intomainfrom
audio-splice-description
Open

Add image description text for the audio splice rendering image#366
chrisn wants to merge 2 commits intomainfrom
audio-splice-description

Conversation

@chrisn
Copy link
Copy Markdown
Member

@chrisn chrisn commented Jun 24, 2025

See #312


Preview | Diff

@marcoscaceres
Copy link
Copy Markdown
Member

Having multiple files seems sub optimal, as the description will likely fall out of sync. Can we instead just throw the relevant information into a <details> element? Also, the information should be written to be suitable for all audiences, not specifically for someone using assistive technology (it seems somewhat excessive in its description).

Copy link
Copy Markdown
Member

@tidoust tidoust left a comment

Choose a reason for hiding this comment

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

That looks good to me, thanks for addressing the issue!

@tidoust
Copy link
Copy Markdown
Member

tidoust commented Jun 25, 2025

Hadn't seen @marcoscaceres's comment before I reviewed. This PR has the advantage of using a consistent scheme and approach for both images in the spec, but I don't disagree that the description (in both cases) seems excessive and would better be integrated within the main spec. Up to you :)

Copy link
Copy Markdown
Member

@marcoscaceres marcoscaceres left a comment

Choose a reason for hiding this comment

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

Let's move what we can into the main document. Having these kind of linked descriptions don't make a lot of sense and can quickly get out of sync.

@chrisn
Copy link
Copy Markdown
Member Author

chrisn commented Oct 28, 2025

I've removed the additional page, and add a <details> element. I shortened the text by just keeping the first paragraph. It's is enough to describe what's going on, I think.

@marcoscaceres @tidoust, please review. Thanks!

Copy link
Copy Markdown
Member

@tidoust tidoust left a comment

Choose a reason for hiding this comment

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

Looks good. I guess we should also apply the same logic to the pipeline model diagram afterwards.

@chrisn
Copy link
Copy Markdown
Member Author

chrisn commented Oct 30, 2025

Sounds good, yes. I've adjusted the pipeline model description in this PR.

@marcoscaceres marcoscaceres requested a review from Copilot October 31, 2025 08:08
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR removes a standalone HTML file describing the Media Source Pipeline Model and integrates its content directly into the main specification document. The changes improve accessibility by replacing external links with inline descriptions and adding proper image descriptions for diagrams.

  • Deleted the separate pipeline_model_description.html file
  • Embedded the pipeline model description as a collapsible <details> element within the main specification
  • Added image descriptions for the audio splice diagram
  • Fixed minor formatting issues (trailing whitespace, spelling corrections)

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.

File Description
pipeline_model_description.html Removed standalone HTML file containing the pipeline model description
media-source-respec.html Integrated pipeline model description inline, added audio splice image description, fixed spelling and formatting issues

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Media Source Pipeline Model Diagram
</figcaption>
</figure>
<details class="note">
Copy link
Copy Markdown
Member

@marcoscaceres marcoscaceres Oct 31, 2025

Choose a reason for hiding this comment

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

I think the details should be moved inside the <figcaption> (or ideally removed entirely).

@marcoscaceres marcoscaceres requested a review from Copilot October 31, 2025 08:17
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@marcoscaceres
Copy link
Copy Markdown
Member

I added <desc> to the SVG file, and got chatty to write an appropriate summary based on the current PR.

I still think this is excessive and we shouldn't add the <details> element. The SVGs' new <desc> should suffice and we should extend that description if need be.

@marcoscaceres marcoscaceres force-pushed the audio-splice-description branch from bf960ce to 622634b Compare November 4, 2025 23:27
@marcoscaceres marcoscaceres force-pushed the audio-splice-description branch from 622634b to 0946914 Compare November 4, 2025 23:30
Copy link
Copy Markdown
Member

@marcoscaceres marcoscaceres left a comment

Choose a reason for hiding this comment

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

I'm still very much opposed to this change, on accessibility grounds. Particularly this is violation of:

  • Avoid Too Much Content: "Too much information or instruction can be just as much of a hindrance as too little. The goal is to make certain that enough information is provided for the user to accomplish the task without undue confusion or navigation."
  • Particularly, having the headings in there was super confusing.

The correct way to handle this is three fold:

  • The spec text itself should describe the what the flows are. If there is stuff in the detailed description that is not covered by the spec text, then we should fold that into there.
  • I've expanded the figure caption text to describe the what is in the diagram.
  • The SVG itself describes what is in the diagram using desc.

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.

5 participants