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

Structure overhaul #1187

Merged
merged 4 commits into from
Jun 26, 2024
Merged

Structure overhaul #1187

merged 4 commits into from
Jun 26, 2024

Conversation

patrys
Copy link
Member

@patrys patrys commented Jun 18, 2024

  • Split documentation into several pages with separate sidebars
  • Unified the structure somewhat
  • Removed what looks like accidental commits to the API reference
  • Got rid of some complex custom sidebar formatting
  • Dropped giscus and "was this page helpful?"

@patrys patrys requested review from aniav and mirekm June 18, 2024 13:41
@patrys patrys requested a review from a team as a code owner June 18, 2024 13:41
Copy link

vercel bot commented Jun 18, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
saleor-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 26, 2024 5:01pm

Copy link
Member

@peelar peelar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • "Core Concepts" is missing an overview page
image
  • "Core Concepts" has its item in both the sidebar navigation and top navigation
Zrzut ekranu 2024-06-19 o 12 42 50

@@ -15,28 +15,10 @@

.menu__link {
font-size: var(--font-size-sm);
color: var(--gray10);
transition: all 0.3s ease-in-out;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion:
(I hope this is the right place)

IMO, we should decrease the duration of the transition. Moving cursor from top of the sidebar item list to the bottom leaves a background color "smudge" for too long (to my taste).

Nagranie.z.ekranu.2024-06-19.o.12.41.16.mov

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is completely unrelated to this PR, though. I only reverted even uglier sidebar styling to its original state.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I disagree it's unrelated. You changed the way the sidebar looks and I was just sharing my opinion that this particular bit, to me, now looks off.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I removed all easing from the sidebar, so the animation is gone entirely.

@patrys
Copy link
Member Author

patrys commented Jun 19, 2024

@peelar

"Core Concepts" is missing an overview page

You are welcome to write something there. I wanted to have a predictable link target but I don't have the time to create new content.

"Core Concepts" has its item in both the sidebar navigation and top navigation

That's intentional. The same is true for all the other links from the top nav as they are merely shortcuts.

@timuric
Copy link
Member

timuric commented Jun 19, 2024

I think "Extending Saleor" belongs to core concept

@timuric
Copy link
Member

timuric commented Jun 19, 2024

About Saleor can not be collapsed as Why saleor
image

@patrys
Copy link
Member Author

patrys commented Jun 19, 2024

@timuric

I think "Extending Saleor" belongs to core concept

I wanted "core concepts" to be about using Saleor, not building stuff around it. You are welcome to propose a better name for the section. Medusa calls a similar thing "Commerce Modules."

- Split documentation into several pages with separate sidebars
- Unified the structure somewhat
- Removed what looks like accidental commits to the API reference
- Got rid of some complex custom sidebar formatting
- Dropped giscus and "was this page helpful?"
@timuric
Copy link
Member

timuric commented Jun 26, 2024

@aniav we can merge now?

@aniav
Copy link
Contributor

aniav commented Jun 26, 2024

@timuric had to do path tweaks, once vercel builds I will merge to not block anything any more 🙌

@aniav aniav merged commit fa2c023 into main Jun 26, 2024
7 checks passed
@aniav aniav deleted the restructure-docs branch June 26, 2024 17:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants