Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Change how we do versioning #1532

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

Draft
titusfortner wants to merge 6 commits into trunk
base: trunk
Choose a base branch
Loading
from versions
Draft

Change how we do versioning #1532

titusfortner wants to merge 6 commits into trunk from versions

Conversation

@titusfortner
Copy link
Member

@titusfortner titusfortner commented Nov 24, 2023
edited
Loading

Description

  • Remove the Legacy stuff from the sidebar and put it in a separate directory
  • Add version toggle between "Documentation" and "Legacy" (削除) in the nav bar (削除ここまで) above breadcrumbs
  • Change 4.0 to 4.15 as the "current version"
  • Remove all the "This code requires Selenium xxx or greater" badges

Motivation and Context

  • (削除) drop down in nav bar is the default Docsy way to do it (削除ここまで) This was going to be the default Docsy way, but it didn't make sense to have versions always displayed in NavBar even when not on documentation page. Also, I customized the toggle so the dropdown gives the version being displayed, not a title hard-coded in the toml file
  • The badges were apparently confusing
  • The Legacy section really shouldn't be shown in the sidebar.

What do you think? Is this better?

Update:

Because we are only translating the documentation, it might make sense to move that to the new place as well?

What do we think? Put it back?

Copy link

netlify bot commented Nov 24, 2023
edited
Loading

Deploy Preview for selenium-dev ready!

Name Link
🔨 Latest commit e500b12
🔍 Latest deploy log https://app.netlify.com/sites/selenium-dev/deploys/6567cc1ecb65e00008d3aa4e
😎 Deploy Preview https://deploy-preview-1532--selenium-dev.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Member Author

looks like this is on all pages, not just documentation page, so need to fix that....

@titusfortner titusfortner marked this pull request as ready for review November 25, 2023 06:04
Copy link
Member

@diemol diemol left a comment

Choose a reason for hiding this comment

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

This opens the door to maintain different versions of the documentation. Do we want that? Do we have the time and people to do that?

I am fine with removing the badges and doing something about it. But I am skeptical about having a version drop down.

Copy link
Member Author

  1. It's dumb to have Legacy stuff in the documentation, we at least should figure out someplace else to put that /somehow/
  2. Right now we're putting badges on any code with a minimum version of what is needed for it to work. I actually like this, but I've been told it is confusing...
  3. I do think we should be versioning our code, but it doesn't make sense to do this until we have all of our docs actually updated 😂

Copy link
Member

diemol commented Nov 27, 2023

It's dumb to have Legacy stuff in the documentation, we at least should figure out someplace else to put that /somehow/

If Legacy is confusing, then why not hide it?

To hide a page or section from the left navigation menu, set toc_hide: true in the front matter.

https://www.docsy.dev/docs/adding-content/navigation/#section-menu

Copy link
Member Author

(in case it wasn't obvious, I'm the one who set Legacy to be where it is now, so I'm calling what I did previously dumb).
I'll take a look at hiding it.

@titusfortner titusfortner marked this pull request as draft November 29, 2023 23:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@diemol diemol diemol left review comments

@harsha509 harsha509 Awaiting requested review from harsha509

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

AltStyle によって変換されたページ (->オリジナル) /