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

feat: The headline is not in the right place. #64

Open
1 task done
YasinSpace opened this issue Dec 4, 2024 · 17 comments
Open
1 task done

feat: The headline is not in the right place. #64

YasinSpace opened this issue Dec 4, 2024 · 17 comments
Labels
✨ feature New feature or request

Comments

@YasinSpace
Copy link

YasinSpace commented Dec 4, 2024

Describe the feature

Screenshot 2024-12-04 at 16 49 41

As you can see,

the state in the title is not positioned correctly when we click on a title!

And specify this or add in the feature: Please add this : in config file we can change the size of the sidebar, for example, set it more forward or more backward ( resize ) by default. =)

Additional information

  • Would you be willing to help implement this feature?
@YasinSpace YasinSpace added the ✨ feature New feature or request label Dec 4, 2024
@kalix127
Copy link
Contributor

kalix127 commented Jan 3, 2025

I’d like to help fix it, but I could use a bit more info:

  1. Could you share a clearer screenshot of the issue with the title’s state position?
  2. If possible, a quick code snippet of how the titles or sidebar are handled would help me understand the issue better.

I’ve tried reproducing the issue on my end with the same icon and text, but I didn’t notice any problems. Maybe I’m missing something.

Let me know, and I can start working on this.

@Ast3risk-ops
Copy link
Contributor

I’d like to help fix it, but I could use a bit more info:

1. Could you share a clearer screenshot of the issue with the title’s state position?

2. If possible, a quick code snippet of how the titles or sidebar are handled would help me understand the issue better.

I’ve tried reproducing the issue on my end with the same icon and text, but I didn’t notice any problems. Maybe I’m missing something.

Let me know, and I can start working on this.

I've noticed it with the official site on smaller screens (on components > package manager)

@kalix127
Copy link
Contributor

kalix127 commented Jan 4, 2025

I found the problem, and it doesn't seem like a real or actual problem.
There are 2 reasons:

  1. Users are not very likely to browse docs on mobile.
  2. Even if a user is on mobile, they must have a screen smaller than 290px, which is really unlikely nowadays.

That said, it is fixable but... is it really worth it?

@Ast3risk-ops
Copy link
Contributor

Ast3risk-ops commented Jan 4, 2025

I found the problem, and it doesn't seem like a real or actual problem. There are 2 reasons:

1. Users are not very likely to browse docs on mobile.

2. Even if a user is on mobile, they must have a screen smaller than 290px, which is really unlikely nowadays.

That said, it is fixable but... is it really worth it?

Speak for yourself, plenty of people browse the internet on mobile (especially in places like China). That said, this is still a really small problem.

@YasinSpace
Copy link
Author

YasinSpace commented Jan 5, 2025

As you mentioned, the issue is minor and small! However, as you can see, I am on the desktop, and when I increase the submenus, they are displayed correctly in normal mode. But when the mouse hovers over them, they turn red. This hover effect has become extremely thin, and unlike the others, there's no extra space around it for aesthetic purposes. This happens even when there's some protrusion, and in the first image I sent, I was on the desktop, not on mobile! You can see that the word "Google Dorking" has clearly protruded.

CleanShot 2025-01-05 at 13 25 32@2x

VS.

CleanShot 2025-01-05 at 13 24 01@2x

@kalix127
Copy link
Contributor

kalix127 commented Jan 5, 2025

it makes sense.
If I have time later I'll try to fix it
(initially I didn't think about the fact that a user can potentially have infinite sub-menus)

@kalix127
Copy link
Contributor

kalix127 commented Jan 5, 2025

@YasinSpace I'm working on it now, i'll open a PR soon.
Obviously by greatly increasing the size of the sidebar, it becomes almost mandatory to remove the "toc" section on the right otherwise there is very little space left for the docs themselves.

Ignore the item names and section, I simply pasted the sections to simulate many sub-menus.
image

@Ast3risk-ops
Copy link
Contributor

@YasinSpace I'm working on it now, i'll open a PR soon. Obviously by greatly increasing the size of the sidebar, it becomes almost mandatory to remove the "toc" section on the right otherwise there is very little space left for the docs themselves.

Ignore the item names and section, I simply pasted the sections to simulate many sub-menus. image

Which means this is more of an issue with organization than anything else. If you have that many subsections you may need to reorganize your pages. (Folders with a _dir.yml will appear above the pages and are better for organizing).

This should be a choice or conditional.

@kalix127
Copy link
Contributor

kalix127 commented Jan 5, 2025

Yes of course it's optional, that's a new prop to the aside in the app config.

@Ast3risk-ops
Copy link
Contributor

Ast3risk-ops commented Jan 5, 2025

CleanShot 2025-01-05 at 13 25 32@2x

VS.

CleanShot 2025-01-05 at 13 24 01@2x

Basically, I'm just saying this could be organized better (still a good idea to add the option)

@kalix127
Copy link
Contributor

kalix127 commented Jan 5, 2025

Do you have any suggestions?

With TOC:
image

Without TOC:
image

I think this solves the problem presented by @YasinSpace , if you want to have 20 levels of indentation you will have tradeoffs obviously.

@Ast3risk-ops
Copy link
Contributor

Ast3risk-ops commented Jan 5, 2025

Do you have any suggestions?

obv. introduction should be a root-level folder.

The Methodologies section seems to be their attempt to create section index pages (which the theme should have, but doesn't) and should be reworked with less sections (i.e. do we need to specify pentesting methodologies under methodologies when we only discuss pentesting?)

edit: there's a reason the official docs do not use many subfolders, they're organized properly.

@kalix127
Copy link
Contributor

kalix127 commented Jan 5, 2025

Having introduction as root-level is ok, but the problem remains. You have only removed 1 level of indentation no?
I hope I didn't misunderstand

@Ast3risk-ops
Copy link
Contributor

Ast3risk-ops commented Jan 5, 2025

Having introduction as root-level is ok, but the problem remains. You have only removed 1 level of indentation no? I hope I didn't misunderstand

It's possible to remove more by cutting out subfolders. I explained we can cut out methodologies for pentesting as well. (methodologies too since that would be a root-level folder)

That would likely be enough to fix the issue (still nice to have that option tho).

@kalix127
Copy link
Contributor

kalix127 commented Jan 5, 2025

Yes, I understand the meaning and I agree that it is better, but I don't have the time to do it now.
In the meantime we can use this new option, then we'll see.

@Ast3risk-ops
Copy link
Contributor

Yes, I understand the meaning and I agree that it is better, but I don't have the time to do it now. In the meantime we can use this new option, then we'll see.

You didn't make the site? The OP did.

@kalix127
Copy link
Contributor

kalix127 commented Jan 5, 2025

No i didn't

edit: ok no, maybe it makes more sense to wait and do it as you say.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
✨ feature New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants