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

Improve the link to docs on each package #2273

Closed
javiereguiluz opened this issue Oct 14, 2024 · 3 comments
Closed

Improve the link to docs on each package #2273

javiereguiluz opened this issue Oct 14, 2024 · 3 comments
Labels
docs Improvements or additions to documentation

Comments

@javiereguiluz
Copy link
Member

In the current web design, the Documentation link is displayed at the bottom of the page. For most folks, this is way below the visible contents when loading the page:

I propose to display a link to the docs right next to the command shown to install the package:

Don't mind the text and the "design" of my mockup. It's just a quick mockup to give you an idea of the exact location where I'd like this link to be.

@javiereguiluz javiereguiluz added the docs Improvements or additions to documentation label Oct 14, 2024
@Kocal
Copy link
Member

Kocal commented Oct 14, 2024

That would be a great improvment :)

@smnandre
Copy link
Member

Sub menus for every package pages is a work in progress... i really hope to release all this before vienna :)

Kocal added a commit that referenced this issue Dec 7, 2024
…uiluz, Kocal)

This PR was merged into the 2.x branch.

Discussion
----------

Show a visible link to the docs of each package

| Q             | A
| ------------- | ---
| Bug fix?      | yes
| New feature?  | no
| Issues        | #2273
| License       | MIT

I know that you mentioned that there's a work-in-progress effort to update some things in the current design (#2273 (comment)) but I think we should fix this issue quickly because it's a problem in many long package pages.

If you don't like the proposed changes here it's fine; let's iterate over them. Tell me what to fix or change and I'll do it. Thanks!

This is how this PR looks at the moment:

![](https://github.com/user-attachments/assets/372918e7-c72e-4d03-8f5a-5e56d8a9c76b)

#SymfonyHackday :)

Commits
-------

7c2ad1d [Site] Rework "Read the docs" button on packages pages
3bc80c5 Show a visible link to the docs of each package
@Kocal
Copy link
Member

Kocal commented Dec 7, 2024

Closing, since #2309 has been merged

@Kocal Kocal closed this as completed Dec 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants