Skip to content

Commit ab89f08

Browse files
ntjohnson1IsseW
authored andcommitted
Make getting started viewable on sidebar (#11874)
### Related #11873 ### What * Adds pixi commands for the lychee install I added * Also make the getting started side panel viewable but with the correct re-direct. * I ran `pixi run link-check` and it looks like it is ok ## Before <img width="254" height="199" alt="Screenshot 2025-11-12 at 8 57 10 AM" src="https://github.com/user-attachments/assets/a0d14307-5622-4740-8e7b-f25955896e0f" /> ## After <img width="254" height="322" alt="Screenshot 2025-11-12 at 9 49 35 AM" src="https://github.com/user-attachments/assets/2a8aea28-f7d4-48e7-8773-d9094f9af263" />
1 parent 2da7e77 commit ab89f08

File tree

3 files changed

+16
-7
lines changed

3 files changed

+16
-7
lines changed

.github/workflows/reusable_checks.yml

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -263,19 +263,21 @@ jobs:
263263
key: cache-lychee-${{ github.sha }}
264264
restore-keys: cache-lychee-
265265

266+
- name: Set up pixi for PR Link Checker
267+
if: ${{ inputs.CHANNEL == 'pr' }}
268+
uses: prefix-dev/[email protected]
269+
with:
270+
pixi-version: v0.55.0
271+
266272
# For PRs: Check only links in added lines
267273
- name: PR Link Checker (added lines only)
268274
if: ${{ inputs.CHANNEL == 'pr' }}
269275
run: |
270-
# Install lychee
271-
curl -sSL https://github.com/lycheeverse/lychee/releases/download/lychee-v0.20.1/lychee-x86_64-unknown-linux-gnu.tar.gz | tar -xz
272-
sudo mv lychee /usr/local/bin/
273-
274276
# Fetch the base branch
275277
git fetch origin ${{ github.base_ref }}:${{ github.base_ref }}
276278
277279
# Run our custom PR link checker
278-
python3 scripts/ci/pr_link_checker.py --base-ref origin/${{ github.base_ref }}
280+
pixi run link-check-pr origin/${{ github.base_ref }}
279281
280282
# For nightly: Check all links in the entire codebase
281283
- name: Full Link Checker
@@ -287,5 +289,6 @@ jobs:
287289
lycheeVersion: "v0.20.1"
288290
# When given a directory, lychee checks only markdown, html and text files, everything else we have to glob in manually.
289291
# Pass --verbose, so that all considered links are printed, making it easier to debug.
292+
# If updating version or args update the pixi.toml to match.
290293
args: |
291294
--verbose --cache --max-cache-age 1d . --base . "**/*.md" "**/*.rs" "**/*.toml" "**/*.hpp" "**/*.cpp" "**/CMakeLists.txt" "**/*.py" "**/*.yml"

docs/content/getting-started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Quickstart
3-
hidden: true
2+
title: Getting Started
3+
order: 1
44
redirect: getting-started/quick-start
55
---

pixi.toml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -238,6 +238,12 @@ rs-fmt = "cargo fmt --all"
238238
format = { depends-on = ["cpp-fmt", "misc-fmt", "pb-fmt", "py-fmt", "rs-fmt", "toml-fmt"] }
239239
fmt = { depends-on = ["format"] }
240240

241+
# Check links
242+
link-check-pr = { cmd = "python scripts/ci/pr_link_checker.py --base-ref {{ ref }}", args = [
243+
{ arg = "ref" },
244+
] }
245+
link-check = 'lychee --verbose --cache --max-cache-age 1d . --base . "**/*.md" "**/*.rs" "**/*.toml" "**/*.hpp" "**/*.cpp" "**/CMakeLists.txt" "**/*.py" "**/*.yml"'
246+
241247
# Assorted linting tasks
242248
fast-lint = "python scripts/fast_lint.py"
243249
lint-codegen = "cargo --quiet run --package re_types_builder -- --check"

0 commit comments

Comments
 (0)