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

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

josh-wong
Copy link
Member

@josh-wong josh-wong commented Dec 4, 2024

Caution

This PR should not be merged until after we're ready to add the displayed_sidebar: docsEnglish configuration to the front-matter properties of English docs and displayed_sidebar: docsJapanese configuration to the front-matter properties of Japanese docs. By adding this configuration, we can specify the appropriate sidebar language that should be displayed for the respective language when the visitor is on a page.

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

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

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.

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

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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
sidebar navigation Updates to the sidebar navigation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant