Skip to content

Update sidebar navigation for version 3.9 of English and Japanese docs #597

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 19 commits into from
Jan 14, 2025
Merged

Update sidebar navigation for version 3.9 of English and Japanese docs #597

merged 19 commits into from
Jan 14, 2025

Conversation

@josh-wong
Copy link
Member

@josh-wong josh-wong commented Dec 4, 2024 •
edited
Loading

Description

This PR updates the sidebar navigation for ScalarDL 3.9 (and will apply to later versions as well). Since we'll be hard-coding titles (labels) in the sidebar navigation in the near future, we should address this now before it becomes an issue.

If we don't specify which sidebar navigation to show for each language, the sidebar navigation for Japanese docs would show in English.

Note

This method follows Docusaurus's method for sidebars, as described in Understanding sidebar association.

  • We hard-code the titles (labels) in the sidebar navigation so that we can make the titles shorted in the sidebar navigation while keeping longer titles at the top of each doc. Keeping titles within the actual doc provides readers with better context and is better for SEO.
  • We'll re-organize the sidebar contents in a different PR.

See an example of the sidebar navigation at:

Related issues and/or PRs

Note

Similar changes are being done in the ScalarDB docs:

Changes made

  • Changed the default sidebar name from docs to docsEnglish.
  • Added a sidebar structure for Japanese docs (docsJapanese) that matches the English docs.
  • Translated the titles (labels) in the docsJapanese sidebar into Japanese.

Checklist

The following is a best-effort checklist. If any items in this checklist are not applicable to this PR or are dependent on other, unmerged PRs, please still mark the checkboxes after you have read and understood each item.

  • I have updated the side navigation as necessary.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have updated the documentation to reflect the changes. N/A
  • Any remaining open issues linked to this PR are documented and up-to-date (Jira, GitHub, etc.).
  • My changes generate no new warnings.
  • Any dependent changes in other PRs have been merged and published.

Additional notes (optional)

N/A

@josh-wong
Add docsJapanese navigation
71de214 
This navigation is necessary since we will be hard-coding titles (`labels`) in the sidebar navigation in the near future. Without this, the sidebar navigation for Japanese docs would show in English.
@josh-wong josh-wong added the sidebar navigation Updates to the sidebar navigation label Dec 4, 2024
@josh-wong josh-wong self-assigned this Dec 4, 2024
@josh-wong josh-wong mentioned this pull request Dec 4, 2024
Merged
6 tasks
@josh-wong josh-wong marked this pull request as ready for review December 19, 2024 03:24
jnmt
jnmt reviewed Dec 19, 2024
View reviewed changes
Copy link
Contributor

@jnmt jnmt left a comment

Choose a reason for hiding this comment

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

Thank you! Almost LGTM. I left a few comments. PTAL!

@netlify
Copy link

netlify bot commented Dec 19, 2024 •
edited
Loading

✅ Deploy Preview for staging-scalardl-docs-site ready!

Name Link
🔨 Latest commit 4b5286d
🔍 Latest deploy log https://app.netlify.com/sites/staging-scalardl-docs-site/deploys/678620cb55d49f000889eff0
😎 Deploy Preview https://deploy-preview-597--staging-scalardl-docs-site.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse		 1 paths audited
Performance: 56
Accessibility: 98
Best Practices: 92
SEO: 96
PWA: 90
View the detailed breakdown and full score reports

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

josh-wong
josh-wong commented Dec 19, 2024
View reviewed changes
Copy link
Member Author

@josh-wong josh-wong left a comment

Choose a reason for hiding this comment

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

@jnmt Thank you for the review! I've applied your suggestions in 0b2c8fe and f1ff29a. PTAL again when you have time.

jnmt
jnmt approved these changes Dec 20, 2024
View reviewed changes
Copy link
Contributor

@jnmt jnmt left a comment

Choose a reason for hiding this comment

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

Thank you for revising it! I left a very minor improvement, but basically LGTM.

@josh-wong
Make Japanese titles consistent with ScalarDB titles
7e4b2e0 
Make Japanese titles consistently use noun form, as mentioned in the PR for the ScalarDB sidebar navigation (https://github.com/scalar-labs/docs-scalardb/pull/762/files/1c1b5404f5b23485105ae6a17a42977ecdc5aac3#r1869009005).
josh-wong
josh-wong commented Dec 23, 2024
View reviewed changes
Copy link
Member Author

@josh-wong josh-wong left a comment

Choose a reason for hiding this comment

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

@jnmt I address your comment and made some related changes in 7e4b2e0. PTAL!

@josh-wong josh-wong requested a review from jnmt December 23, 2024 07:59
feeblefakie
feeblefakie reviewed Dec 24, 2024
View reviewed changes
kota2and3kan
kota2and3kan reviewed Dec 25, 2024
View reviewed changes
Copy link

@kota2and3kan kota2and3kan left a comment

Choose a reason for hiding this comment

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

Thank you for the updates! (And sorry for my late review...)
I left several comments and suggestions.
Please take a look when you have time! 🙇‍♂️

feeblefakie
feeblefakie approved these changes Jan 6, 2025
View reviewed changes
Copy link
Collaborator

@feeblefakie feeblefakie left a comment

Choose a reason for hiding this comment

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

For just introducing sidebar.js and stop hard-coding the sidebar menus, it's fine.
In that case, let's not update the content at all.

Anyway, I think all the sidebar menus need to be updated soon.

@jnmt @josh-wong
Update sidebars.js
1cbac91 
Co-authored-by: Josh Wong <joshua.wong@scalar-labs.com>
jnmt
jnmt approved these changes Jan 7, 2025
View reviewed changes
Copy link
Contributor

@jnmt jnmt left a comment

Choose a reason for hiding this comment

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

LGTM, thank you!

@josh-wong josh-wong force-pushed the sidebar-nav/update-structure branch from 5ecf5c5 to 0256034 Compare January 7, 2025 09:04
@josh-wong josh-wong requested a review from kota2and3kan January 8, 2025 02:18
@josh-wong
Copy link
Member Author

josh-wong commented Jan 8, 2025

@kota2and3kan I've addressed your comments and others that we discussed in today's short meeting (0368d93). PTAL!

kota2and3kan
kota2and3kan approved these changes Jan 9, 2025
View reviewed changes
Copy link

@kota2and3kan kota2and3kan left a comment

Choose a reason for hiding this comment

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

LGTM! Thank you!

@josh-wong josh-wong force-pushed the sidebar-nav/update-structure branch from fcd75d8 to cc1b4a3 Compare January 14, 2025 06:06
@josh-wong josh-wong force-pushed the sidebar-nav/update-structure branch from b55f7a8 to 3694e9d Compare January 14, 2025 08:24
@josh-wong josh-wong merged commit 7d8b301 into main Jan 14, 2025
5 checks passed
@josh-wong josh-wong deleted the sidebar-nav/update-structure branch January 14, 2025 08:43
This was referenced Jan 16, 2025
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@feeblefakie feeblefakie feeblefakie approved these changes

@jnmt jnmt jnmt approved these changes

@kota2and3kan kota2and3kan kota2and3kan approved these changes

Assignees

@josh-wong josh-wong

Labels

sidebar navigation Updates to the sidebar navigation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@josh-wong @feeblefakie @jnmt @kota2and3kan