Skip to content

Commit

Permalink
Merge branch 'main' into hd-docs-pnpm-install-add
Browse files Browse the repository at this point in the history
* 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)
  ...
  • Loading branch information
HiDeoo committed Jan 15, 2024
2 parents 6f0bc79 + d7887a5 commit 631a404
Show file tree
Hide file tree
Showing 220 changed files with 3,550 additions and 1,809 deletions.
2 changes: 1 addition & 1 deletion .changeset/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"access": "public",
"baseBranch": "main",
"updateInternalDependencies": "patch",
"ignore": ["starlight-docs", "@example/*", "docs-i18n-tracker"],
"ignore": ["starlight-docs", "@example/*"],
"___experimentalUnsafeOptions_WILL_CHANGE_IN_PATCH": {
"onlyUpdatePeerDependentsWhenOutOfRange": true
}
Expand Down
1 change: 1 addition & 0 deletions .github/labeler.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ i18n:
- docs/src/content/docs/tr/**/*
- docs/src/content/docs/hi/**/*
- docs/src/content/docs/da/**/*
- docs/src/content/docs/uk/**/*

'🌟 core':
- packages/starlight/**
Expand Down
28 changes: 18 additions & 10 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -74,19 +74,27 @@ jobs:
working-directory: ./docs
run: pnpm build

docs-i18n-tracker-smoke:
name: Docs i18n tracker builds
links:
name: Check for broken links
runs-on: ubuntu-20.04
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0
- uses: pnpm/action-setup@v2
- uses: actions/setup-node@v3
- name: Checkout
uses: actions/checkout@v3

- name: Setup PNPM
uses: pnpm/action-setup@v2

- name: Setup Node
uses: actions/setup-node@v3
with:
node-version: ${{ env.NODE_VERSION }}
cache: 'pnpm'
- run: pnpm i
- name: Build docs i18n tracker
working-directory: ./docs-i18n-tracker

- name: Install Dependencies
run: pnpm i

- name: Build docs site and check links
working-directory: ./docs
run: pnpm build
env:
CHECK_LINKS: true
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,20 @@ You should then be able to open <http://localhost:4321> and see your changes.
> **Note**
> Changes to the Starlight integration will require you to quit and restart the dev server to take effect.
### Check for broken links in the docs site

When adding or translating content in the Starlight docs site, you can check all internal links are valid.
All GitHub PRs are checked this way automatically, but testing locally can help if you want to confirm changes are correct before committing them.

To do this, move into the `docs/` directory from the root of the repo and then build the site with the `CHECK_LINKS` environment variable:

```sh
cd docs
CHECK_LINKS=true pnpm build
```

If there are any broken links, the build will fail and log which pages need to be fixed.

### Unit tests

The Starlight package includes unit tests in [`packages/starlight/__tests__/`](./packages/starlight/__tests__/), which are run using [Vitest][vitest].
Expand Down Expand Up @@ -203,6 +217,7 @@ Visit **<https://i18n.starlight.astro.build>** to track translation progress for
To add a language, you will need its BCP-47 tag and a label. See [“Adding a new language”](https://github.com/withastro/docs/blob/main/contributor-guides/translating-astro-docs.md#adding-a-new-language) in the Astro docs repo for some helpful tips around choosing these.

- Add your language to the `locales` config in `docs/astro.config.mjs`
- Add your language to the `locales` config in `docs/lunaria.config.json`
- Add your language’s subtag to the i18n label config in `.github/labeler.yml`
- Add your language to the `pa11y` script’s `--sitemap-exclude` flag in `package.json`
- Create the first translated page for your language.
Expand Down
21 changes: 0 additions & 21 deletions docs-i18n-tracker/.gitignore

This file was deleted.

9 changes: 0 additions & 9 deletions docs-i18n-tracker/README.md

This file was deleted.

18 changes: 0 additions & 18 deletions docs-i18n-tracker/build.ts

This file was deleted.

23 changes: 0 additions & 23 deletions docs-i18n-tracker/lib/filter-warnings.cjs

This file was deleted.

33 changes: 0 additions & 33 deletions docs-i18n-tracker/lib/github-get.mjs

This file was deleted.

78 changes: 0 additions & 78 deletions docs-i18n-tracker/lib/output.mjs

This file was deleted.

Loading

0 comments on commit 631a404

Please sign in to comment.