Skip to content

[AX] Code blocks are hard to reach and follow while reading a tutorial #949

Open
@marinaaisa

Description

@marinaaisa

Description

Issues found:

  • We don’t notify the user when the code block is going to be updated and when has been updated.
  • We don’t provide an alternative and manual way to update the code block.
  • The code block is too far away in the HTML tree of each step description, so the user cannot find it.

Checklist

  • If possible, I've reproduced the issue using the main branch of this package.
  • This issue hasn't been addressed in an existing GitHub issue.

Expected Behavior

  • Users must be notified if the page will be updated as a result of interaction
  • Users must be informed when a content change has occurred
  • Users need an alternative method to manually trigger content updates

Actual behavior

  • We don’t notify the user when the code block is going to be updated and when has been updated.
  • We don’t provide an alternative and manual way to update the code block.
  • The code block is too far away in the HTML tree of each step description, so the user cannot find it.

Steps To Reproduce

  1. Turn on "VoiceOver"
  2. Go to a tutorials page
  3. Navigate through the steps
  4. Assert that updates in the code blocks aren't being notified
  5. Assert that code blocks are only accessible after tabbing all the steps

Swift-DocC-Render Version Information

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions