Skip to content

Documentation / UI improvements: sidebar behavior, “edit page” link & accessibility enhancements #260

@lelixn

Description

@lelixn

What kind of issue is this?

  • Improvement (documentation / UI)

Description
I noticed a few areas in the CleanVision docs site that might benefit from improvements — especially to help ease navigation, accessibility and contributions.

Suggested improvements

  1. Sidebar / navigation behaviour — The toggle for table-of-contents or navigation sidebar, while useful on large screens, can make navigation confusing on narrow windows or mobile devices. Maybe adapt layout for mobile (e.g. collapsible sidebar by default) or ensure toggling doesn’t hide context.
  2. “Edit this page / Report issue” link — There doesn’t appear to be an easy link for users to propose doc fixes or report issues on docs pages. Having a “Edit on GitHub” or “Suggest documentation correction” button can encourage community contributions.
  3. Accessibility enhancements — Ensure documentation meets basic accessibility standards: proper heading levels, alt-text for images (if any), good color-contrast, keyboard navigability, semantic HTML structure.
  4. Copy-code button for code blocks — For easier copying of example code, especially in Quickstart/API sections.

Why it matters

  • Improves readability & usability on small screens / mobile devices.
  • Lowers the barrier for other users/contributors to report doc issues or contribute updates.
  • Makes documentation more accessible to users with visual impairments or those using screen-readers.
  • Enhances developer experience — easier to copy and test code examples quickly.

If desired, I can help implement these changes or draft a PR for the docs site.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions