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.

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

[i18nIgnore] Add src alias #1322

Merged
merged 4 commits into from
Jan 9, 2024
Merged

[i18nIgnore] Add src alias #1322

merged 4 commits into from
Jan 9, 2024

Conversation

at-the-vr
Copy link
Member

@at-the-vr at-the-vr commented Dec 31, 2023 •
edited
Loading

Description

  • brings alias for docs/src path
  • allow users to code navigate using ctrl/cmd + left click - edit: this might be a "Path Intellisense MDX" extension issue 🤔
  • update all necessary markdown files with alias
  • update all necessary .astro components with alias - edit: the components in docs/src path example: sidebar-preview.astro use dependencies from packages/starlight/components. There will another path alias for packages/starlight/components which I am doubtful since its a bit out of scope for this PR

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Dec 31, 2023 •
edited
Loading

⚠️ No Changeset found

Latest commit: 7407af7

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

@vercel Vercel
Copy link

vercel bot commented Dec 31, 2023 •
edited
Loading

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

Name Status Preview Updated (UTC)
starlight ✅ Ready (Inspect) Visit Preview Jan 9, 2024 6:01pm
1 Ignored Deployment
Name Status Preview Updated (UTC)
starlight-i18n ⬜️ Ignored (Inspect) Visit Preview Jan 9, 2024 6:01pm

@github-actions github-actions bot added the 📚 docs Documentation website changes label Dec 31, 2023
@github-actions github-actions bot added the i18n Anything to do with internationalization & translation efforts label Jan 1, 2024
@at-the-vr at-the-vr marked this pull request as ready for review January 1, 2024 19:26
@delucis delucis changed the title Add options for alias [i18nIgnore] Add src alias Jan 9, 2024
delucis
delucis approved these changes Jan 9, 2024
View reviewed changes
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.

Thanks for the work on this @at-the-vr! I just pushed a small commit to also add these changes to a few translations that came in after your initial commits and updated the title to include [i18nIgnore] so that this PR won’t impact translation status on https://i18n.starlight.astro.build/

Re: your two unchecked checkboxes in your PR description:

  1. We discussed the code navigation issue on Discord and concluded it’s an issue with the MDX language server. I think it’s OK to continue with this PR and lose that benefit for now.

  2. I think all content has been updated! The relative imports from packages/starlight I think probably should not be updated and also are imported from internal component code rather than docs content, so I don’t think are as much of an issue.

Given that, I think this is ready to go. Thanks again 🚀

@delucis delucis merged commit f3a524c into withastro:main Jan 9, 2024
9 checks passed
@at-the-vr
Copy link
Member Author

at-the-vr commented Jan 9, 2024 •
edited
Loading

thanks for the the major review 🔥🔥, could not have diagnosed this without everyone's support

@at-the-vr at-the-vr deleted the atv/alias branch January 10, 2024 09:41
HiDeoo added a commit to HiDeoo/starlight that referenced this pull request Jan 15, 2024
@HiDeoo
Merge branch 'main' into hd-docs-pnpm-install-add
631a404 
* main: (55 commits)
  [ci] format
  i18n(es): Update `index` (withastro#1360)
  [ci] format
  i18n(fr): Update index (withastro#1367)
  i18n(es): remove extra section (withastro#1370)
  i18n(ko-KR): update `index.mdx` (withastro#1363)
  [ci] format
  i18n(zh-cn): Update index.mdx (withastro#1361)
  docs(showcase): add OpenSaaS.sh (withastro#1359)
  feat(Testimonials): add testimonials to website (withastro#1104)
  [ci] format
  [ci] release (withastro#1332)
  fix: autogenerated sidebar alphabetical sort (withastro#1298)
  Avoid sidebar scrollbar hiding behind navbar (withastro#1353)
  Use spawnSync instead of execaSync in `git.ts` (withastro#1347)
  [ci] format
  [i18nIgnore] Add src alias (withastro#1322)
  Italian translation for search.devWarning (withastro#1351)
  [ci] format
  i18n(pt-BR): Add translation for `guides/sidebar` (withastro#1346)
  ...
HiDeoo added a commit to HiDeoo/starlight that referenced this pull request Jan 15, 2024
@HiDeoo
Merge branch 'main' into hd-file-tree
93a654d 
* main: (69 commits)
  [i18nIgnore] docs: `pnpm install` → `pnpm add` (withastro#1324)
  [ci] format
  i18n(zh-cn): Update frontmatter.mdx (withastro#1362)
  [ci] format
  i18n(es): Update `index` (withastro#1360)
  [ci] format
  i18n(fr): Update index (withastro#1367)
  i18n(es): remove extra section (withastro#1370)
  i18n(ko-KR): update `index.mdx` (withastro#1363)
  [ci] format
  i18n(zh-cn): Update index.mdx (withastro#1361)
  docs(showcase): add OpenSaaS.sh (withastro#1359)
  feat(Testimonials): add testimonials to website (withastro#1104)
  [ci] format
  [ci] release (withastro#1332)
  fix: autogenerated sidebar alphabetical sort (withastro#1298)
  Avoid sidebar scrollbar hiding behind navbar (withastro#1353)
  Use spawnSync instead of execaSync in `git.ts` (withastro#1347)
  [ci] format
  [i18nIgnore] Add src alias (withastro#1322)
  ...
HiDeoo added a commit to HiDeoo/starlight that referenced this pull request Jan 15, 2024
@HiDeoo
Merge branch 'main' into hd-virtual-pages
823b259 
* main: (62 commits)
  [i18nIgnore] docs: `pnpm install` → `pnpm add` (withastro#1324)
  [ci] format
  i18n(zh-cn): Update frontmatter.mdx (withastro#1362)
  [ci] format
  i18n(es): Update `index` (withastro#1360)
  [ci] format
  i18n(fr): Update index (withastro#1367)
  i18n(es): remove extra section (withastro#1370)
  i18n(ko-KR): update `index.mdx` (withastro#1363)
  [ci] format
  i18n(zh-cn): Update index.mdx (withastro#1361)
  docs(showcase): add OpenSaaS.sh (withastro#1359)
  feat(Testimonials): add testimonials to website (withastro#1104)
  [ci] format
  [ci] release (withastro#1332)
  fix: autogenerated sidebar alphabetical sort (withastro#1298)
  Avoid sidebar scrollbar hiding behind navbar (withastro#1353)
  Use spawnSync instead of execaSync in `git.ts` (withastro#1347)
  [ci] format
  [i18nIgnore] Add src alias (withastro#1322)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@delucis delucis delucis approved these changes

Assignees
No one assigned
Labels
📚 docs Documentation website changes i18n Anything to do with internationalization & translation efforts
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@at-the-vr @delucis