Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add custom sidebar styles and update base template structure #1928

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

payaljhamta
Copy link

@payaljhamta payaljhamta commented Feb 4, 2025

This pull request proposes the following enhancements:

Fixed Sidebar: Implement a fixed sidebar on the left side of documentation pages that remains visible as users scroll, providing constant access to the list of topics.

Closes: #1129
Closes: #1366

Refer the VIDEO :
https://github.com/user-attachments/assets/a4e06798-5364-4c38-8401-069c6253d512

@pauloxnet
Copy link
Member

This pull request proposes the following enhancements:

Fixed Sidebar: Implement a fixed sidebar on the left side of documentation pages that remains visible as users scroll, providing constant access to the list of topics.

Thanks for this PR.

I have 2 first questions:

Another UX changes that would be better to be reviewed from @django/accessibility :)

@payaljhamta
Copy link
Author

This pull request proposes the following enhancements:
Fixed Sidebar: Implement a fixed sidebar on the left side of documentation pages that remains visible as users scroll, providing constant access to the list of topics.

Thanks for this PR.

I have 2 first questions:

Another UX changes that would be better to be reviewed from @django/accessibility :)

Thanks for the update! @pauloxnet

  1. I’ve replaced the div with the aside element as suggested (per MDN).
  2. Also, I’ve tested the layout on mobile screens, Refer this Video
Django.mobile.screen.1129._.Django.mp4

@payal-crossml
Copy link

@pauloxnet Looking forward to the response on the PR.

@pauloxnet
Copy link
Member

@pauloxnet Looking forward to the response on the PR.

Please don't tag me in every message. It's rude and it waste the few free time I have to review all PR. I already reviewed this PR and asked a review from the accessibility team. We would wait for them.

Please be patient, everyone here are doing this for free.

@MHLut
Copy link

MHLut commented Feb 13, 2025

Hello! Accessibility Team member here; thank you for your contribution!

I do not have time for a full review right now, but I would like to request a revert on using aside for the sidebar.

The aside element is only for side content loosely related to the page's main content. With content, I mean the actual text of a specific page, not fixed elements like a page header, footer, and navigation.

Looking at the sidebar, I see it requires more HTML changes beyond this PR's scope, which must be discussed first. Therefore, I recommend keeping this PR as specific as possible and not refactoring beyond what is needed to get this feature to work.

@payaljhamta
Copy link
Author

MHLut

@MHLut Thank you for responding ! Reverted the

changes as requested. Let me know if anything else is needed!

@MHLut
Copy link

MHLut commented Feb 13, 2025

Per Paulo's comment above, please do not tag people with every comment or random tickets.

We are volunteers and do not have infinite time, or energy, or priority to spend on issues.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
4 participants