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

Fix sidebar-weirdness #486

Closed
3 tasks
MinThaMie opened this issue Sep 7, 2023 · 10 comments
Closed
3 tasks

Fix sidebar-weirdness #486

MinThaMie opened this issue Sep 7, 2023 · 10 comments
Assignees

Comments

@MinThaMie
Copy link
Contributor

MinThaMie commented Sep 7, 2023

  • negative margin magic in the guidemaker-template
  • mobile styling needed in API docs
  • word-wrapping for API menu items that don't include slashes

All of the fixes for these cases should go in the sidebar or table of contents CSS here in the styleguide (if we can)

@MinThaMie MinThaMie converted this from a draft issue Sep 7, 2023
@Shub3am
Copy link

Shub3am commented Oct 20, 2023

Hey I was willing to work on this issue, can you reiterate where the guidemaker-template is?

@MinThaMie
Copy link
Contributor Author

So the guidemaker-template lives here: https://github.com/ember-learn/guidemaker-ember-template

@mansona mansona changed the title Fix sidebar-weirdness including: negative margin magic in the guidemaker-template, mobile styling needed in API docs, word-wrapping for API menu items that don't include slashes Fix sidebar-weirdness Oct 26, 2023
@MinThaMie MinThaMie assigned MinThaMie and unassigned MinThaMie Oct 26, 2023
@lukasnys
Copy link

I'll pick this up!

@lukasnys
Copy link

lukasnys commented Feb 1, 2024

I know it's 3 months later but I'm picking this back up 💀

word-wrapping for API menu items that don't include slashes

This point should likelly become "word-wrapping for API menu items that don't include dashes" as the word wrapping happens on dashes but not slashes.

@lukasnys
Copy link

lukasnys commented Feb 1, 2024

@MinThaMie @mansona do either of you have an idea on the best way to about the word wrapping? Maybe a naïve approach, but could we just increase the sidebar width and decrease its padding to create more space?

e.g. the following screenshot uses a padding of var(--spacing-2);/1.125rem (instead of the current var(--spacing-4);/2.25rem) and a sidebar width of 21rem instead of the current 18.5rem.

If you are okay with this approach, I propose to change this directly in the ember-styleguide. Let me know what you think

image

@MinThaMie MinThaMie moved this from Todo to In Progress in Redesign ember-api-docs Feb 5, 2024
@MinThaMie MinThaMie moved this from In Progress to Review in Redesign ember-api-docs Feb 22, 2024
@MinThaMie
Copy link
Contributor Author

Should be fixed by #507

@mansona
Copy link
Member

mansona commented Feb 22, 2024

We will need to update to ember-styleguide@10 to get the new stuff 👍

@lukasnys
Copy link

lukasnys commented Mar 1, 2024

I upgraded to ember-styleguide@9 and cleaned up the redundant styles in ember-learn/guidemaker-ember-template#172. Ignace has already approved this but it could use another pair of eyes.

I upgraded to ember-styleguide@10 and removed the negative margin hack in ember-learn/guidemaker-ember-template#171 if either of you could have a look 🙏 (which I based on PR 172, but I can't figure out how to base my PR onto that one so it shows changes for both PRs)

@mansona
Copy link
Member

mansona commented Mar 7, 2024

do we still need this issue now that #171 is merged?

@mansona
Copy link
Member

mansona commented Mar 7, 2024

turns out not! we can close this 🎉

@mansona mansona closed this as completed Mar 7, 2024
@github-project-automation github-project-automation bot moved this from Review to Done in Redesign ember-api-docs Mar 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

No branches or pull requests

4 participants