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

docs: rewrite guides/sidebar examples to be more generic #1751

Merged

Conversation

HiDeoo
Copy link
Member

@HiDeoo HiDeoo commented Apr 12, 2024

What kind of changes does this PR include?

  • Changes or translations of Starlight docs site content

Description

While working #1750, I realized that the "Sidebar Navigation" guide was present in a lot of search results for unrelated queries (and will be even more after the pagefind v1.1.0 update). This is because the sidebar examples embedded in the guide are re-using the Starlight documentation site's sidebar making it appear in search results for queries like "component", "CSS", etc.

This pull request rewrites the guide examples to be more generic and use constellations/stars/moons instead that are being used in other guides.

  • Previous example links were actually linking to said pages, now they do not redirect anywhere (this uses an invalid anchor - # scroll to the top of the page and others solutions involve JS)
  • The "Internationalization" section involves Brazilian Portuguese translations, I linked the reference I used for the translations but this should be reviewed by a native speaker

Copy link

vercel bot commented Apr 12, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
starlight ✅ Ready (Inspect) Visit Preview Apr 15, 2024 8:36am

@github-actions github-actions bot added the 📚 docs Documentation website changes label Apr 12, 2024
translations: {
'pt-BR': 'Guias',
'pt-BR': 'Constelação',
Copy link
Member Author

Choose a reason for hiding this comment

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

translations: {
'pt-BR': 'Componentes',
'pt-BR': 'Andrômeda',
Copy link
Member Author

Choose a reason for hiding this comment

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

translations: {
'pt-BR': 'Internacionalização (i18n)',
'pt-BR': 'Escorpião',
Copy link
Member Author

Choose a reason for hiding this comment

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

Copy link

changeset-bot bot commented Apr 12, 2024

⚠️ No Changeset found

Latest commit: c405b36

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Member

@delucis delucis left a comment

Choose a reason for hiding this comment

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

This is absolutely fantastic — thank you @HiDeoo!

I wonder if @Fryuni or @yanthomasdev are available to confirm the Portuguese snippet: https://starlight-git-fork-hideoo-hd-docs-refactor-601622-astrodotbuild.vercel.app/guides/sidebar/#internationalization

Co-authored-by: Yan <61414485+yanthomasdev@users.noreply.github.com>
@HiDeoo HiDeoo merged commit 36715ed into withastro:main Apr 15, 2024
9 checks passed
@HiDeoo HiDeoo deleted the hd-docs-refactor-sidebar-navigation-guide branch April 15, 2024 08:40
HiDeoo added a commit to HiDeoo/starlight that referenced this pull request Apr 15, 2024
* main:
  docs: rewrite `guides/sidebar` examples to be more generic (withastro#1751)
  i18n(ja): Update community-content.mdx (withastro#1756)
  i18n(ja): Update configuration.mdx (withastro#1755)
  i18n(zh-cn): Update `configuration.mdx` (withastro#1753)
  i18n(ko-KR): update `configuration.mdx` (withastro#1752)
HiDeoo added a commit to HiDeoo/starlight that referenced this pull request Apr 22, 2024
* main: (32 commits)
  i18n(pt-br): Update `getting-started.mdx` (withastro#1776)
  i18n(es): update `configuration` (withastro#1766)
  [ci] format
  Add TrueCharts to showcases (withastro#1773)
  i18n(zh-cn): Update `sidebar.mdx` (withastro#1761)
  i18n(ko-KR): update `sidebar.mdx` (withastro#1760)
  i18n(fr): update `guides/sidebar` (withastro#1758)
  test: fix Windows path separator test issues (withastro#1759)
  i18n(fr): Update `reference/configuration.mdx` from withastro#1729 (withastro#1757)
  docs: rewrite `guides/sidebar` examples to be more generic (withastro#1751)
  i18n(ja): Update community-content.mdx (withastro#1756)
  i18n(ja): Update configuration.mdx (withastro#1755)
  i18n(zh-cn): Update `configuration.mdx` (withastro#1753)
  i18n(ko-KR): update `configuration.mdx` (withastro#1752)
  docs: add caution about scripts processing when using head config (withastro#1729)
  i18n(es): update `community-content` (withastro#1740)
  i18n(pt-br): Update `resources/community-content.mdx` (withastro#1747)
  format: quick fix
  [ci] format
  [ci] format
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚 docs Documentation website changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants