Update sidebar navigation for version 3.9 of English and Japanese docs #597
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 anddisplayed_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
docs
todocsEnglish
.docsJapanese
) that matches the English docs.labels
) in thedocsJapanese
sidebar into Japanese.Checklist
N/A
Additional notes (optional)
N/A