Skip to content

docs: website design uplift#2872

Merged
B4nan merged 58 commits intomasterfrom
feat/design-uplift-2025
Mar 24, 2025
Merged

docs: website design uplift#2872
B4nan merged 58 commits intomasterfrom
feat/design-uplift-2025

Conversation

@webrdaniel
Copy link
Collaborator

@webrdaniel webrdaniel commented Mar 5, 2025

Deployed here: https://webrdaniel.github.io/:
It is not possible to navigate to the updated /python page as it lives in different repo.

Changes:

  • navigation header (different on index page and javascript pages)
  • footer
  • search modal
  • new index page
  • new /js page

Figma design files are here

Content file: https://www.notion.so/apify/Crawlee-homepage-value-props-12af39950a2280d29d20edb080b2ece9?pvs=4

@github-actions github-actions bot added this to the 109th sprint - Web Team milestone Mar 5, 2025
@github-actions github-actions bot added the t-web Issues with this label are in the ownership of the web team. label Mar 5, 2025
Closes apify/apify-web#4504

---------

Co-authored-by: katzino <katzino@gmail.com>
Co-authored-by: Daniel Wébr <webrdaniel@gmail.com>
@webrdaniel webrdaniel marked this pull request as ready for review March 6, 2025 15:18
@webrdaniel webrdaniel requested review from baldasseva and rezaczu March 6, 2025 15:19
@webrdaniel webrdaniel requested a review from diodames March 7, 2025 10:40
@diodames
Copy link

diodames commented Mar 7, 2025

Hey, great work!
Few things. The code snippet horizontal scroll seems unnecessary (attached screenshot).
Screenshot 2025-03-07 at 11 44 25

On the /Javascript page the code snippet of the benefits seems the spacing of the elements inside is a bit too much.
Screenshot 2025-03-07 at 11 44 54

Probably similar issue below it (attached), can we not have it scrollable maybe so the code fits the text area?
Screenshot 2025-03-07 at 11 46 02

@diodames
Copy link

diodames commented Mar 7, 2025

One more thing that I noticed, it seems like when I click on the menu it's hard to read the text (attached) screenshot, not sure why I see it that way. Specifically the /Javascript and /Python
Screenshot 2025-03-07 at 11 47 44

@webrdaniel
Copy link
Collaborator Author

Updated the code blocks by decreasing the paddings and spacings.
Unfortunetely those does not support wrapping the text to the next line to prevent the scrolling.
We can add some custom css but it wont look good because of the various indents.

@katzino
Copy link
Collaborator

katzino commented Mar 7, 2025

Logo dropdown jumps during initial page laod

Screen.Recording.2025-03-07.at.13.16.47.mov

@katzino
Copy link
Collaborator

katzino commented Mar 7, 2025

Those circles get shrunk by 2px

Screen.Recording.2025-03-07.at.13.19.59.mov

@webrdaniel
Copy link
Collaborator Author

can we also add the third state to the theme switcher (for system default)? i really miss this in the current version.

@B4nan The current version of Docosaurus does not support that, but good news is, that just 4 days ago this feature was merged into the Docosaurus repo. So let's add this once we have the version that supports it. facebook/docusaurus#10987

@webrdaniel webrdaniel requested a review from B4nan March 18, 2025 14:14
@B4nan
Copy link
Member

B4nan commented Mar 18, 2025

Docosaurus does not support that

IMO it's just about removing the saved value so things get inferred based on the system settings. Saying docusaurus doesn't support it would be enough if we wanted to depend on their components, not so much if we create our own - we are in control of what they do.

Copy link

@rezaczu rezaczu left a comment

Choose a reason for hiding this comment

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

Let's send this! 🔥

@webrdaniel
Copy link
Collaborator Author

webrdaniel commented Mar 18, 2025

IMO it's just about removing the saved value so things get inferred based on the system settings.

@B4nan AFAIK currently there is no easy way to detect if system theme is active. The PR has changes outside of the component to be able to detect it, like adding the data-theme-choice.

@B4nan
Copy link
Member

B4nan commented Mar 18, 2025

I don't think this is completely true, you don't need to rely on docusaurus state for this.

Anyway, we can wait for them to ship the new version if you think it will make things easier for us (and I surely don't want to block the PR because of this tiny detail).


One note regarding the merge of this, I understand that you guys all want to have it merged asap, but this needs to be coordinated and will require additional changes to the setup, as well as the addition of (possibly a lot) of redirects. I will try to handle that during this week, but let's not rush it.

@jbartadev
Copy link
Member

One note regarding the merge of this, I understand that you guys all want to have it merged asap, but this needs to be coordinated and will require additional changes to the setup, as well as the addition of (possibly a lot) of redirects. I will try to handle that during this week, but let's not rush it.

@B4nan Thanks Banán! Is there something we can do to help you in the meantime? I know you're busy with other important areas and I'm sure we can help to explore and set up the redirects too. Is there anything else besides the redirects that need to be solved?

@B4nan
Copy link
Member

B4nan commented Mar 19, 2025

I will go through it this afternoon and let you know if there is something I need help with. Maybe I am just too cautious and there won't be too many things to do in the end.

@B4nan
Copy link
Member

B4nan commented Mar 19, 2025

few nits after taking a closer look

  • "deploy to apify" should go to this page instead of the apify docs. python version is here
  • width is now limited to lower numbers and it has effect on the whole docs, that is something we should fix, the docs are looking way too condensed now. just compare those two screenshots
image image

we can keep the limit on the homepage i guess, but for content we need to stretch more (ideally the same as we do now in production)

otherwise i don't see any real problems. redirects should hopefully be simple, and maybe we can even leave that for later and just merge this as it is now, since things will work fine with the current URLs. I'll also check the python version, but i believe those two are pretty much the same

@B4nan
Copy link
Member

B4nan commented Mar 19, 2025

the width also needs to be increased on the blog.

otherwise redirects should be simple, as well as putting docs/api routes under the /js prefix

B4nan added a commit to apify/apify-docs that referenced this pull request Mar 19, 2025
@B4nan
Copy link
Member

B4nan commented Mar 19, 2025

pushed the URL changes, also here is a PR with the redirects: apify/apify-docs#1502

edit: i started fixing the old URLs so we don't rely on redirects internally, and it uncovered some issues with the API docs plugin unfortunately :/

Copy link
Member

@mnmkng mnmkng left a comment

Choose a reason for hiding this comment

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

Appproving not to block this. I'm relying on @B4nan to cover the final tweaks.

@B4nan
Copy link
Member

B4nan commented Mar 20, 2025

CI is green again, I will most likely merge this tomorrow, or on monday.

Copy link
Member

@B4nan B4nan left a comment

Choose a reason for hiding this comment

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

I guess I will leave the merge for monday just in case the redirects would mess up something.

Anyway, great job guys, thank you!

@B4nan B4nan merged commit 2e58992 into master Mar 24, 2025
10 checks passed
@B4nan B4nan deleted the feat/design-uplift-2025 branch March 24, 2025 12:13
B4nan added a commit to apify/apify-docs that referenced this pull request Mar 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

t-web Issues with this label are in the ownership of the web team.

Projects

None yet

Development

Successfully merging this pull request may close these issues.