chore: Small improvements to docs and compatibility

[Fryuni]

Summary by CodeRabbit

Release Notes

• Dependencies

  • Added starlight-cooler-credit package to the documentation project.
  • Updated version compatibility for Starlight and related dependencies.

• Configuration

  • Enabled link validation for documentation.
  • Added credit section to documentation site configuration.

• Compatibility

  • Expanded support for Starlight versions.
  • Made Starlight integration optional for the star-warp package.

• Removal

  • Removed the CHANGELOG.md file documenting version history and updates.

• Updates

  • Updated documentation loader to improve file loading from the content directory.

[vercel]

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

Name	Status	Preview	Updated (UTC)
inox-tools	✅ Ready (Inspect)	Visit Preview	Feb 2, 2025 2:20am

[coderabbitai]

Walkthrough

This pull request introduces updates across various configuration files to enhance compatibility and functionality within the Astro and Star Warp ecosystem. Key changes include a patch for the @inox-tools/star-warp package to broaden its compatibility range, updates to the Astro configuration for improved link validation and credit integration, modifications to package dependencies, and adjustments to version constraints for the Starlight package. Additionally, the CHANGELOG.md file has been removed, eliminating the historical record of version changes.

Changes

File	Change Summary
.changeset/kind-trainers-bathe.md	Patch added for @inox-tools/star-warp
docs/astro.config.ts	- Added import for starlightCoolerCredit - Activated starlightLinksValidator with errorOnRelativeLinks: true - Added starlightCoolerCredit integration
docs/package.json	- Updated version from 0.0.5 to 0.0.0 - Added new dependency: starlight-cooler-credit@^0.2.3
packages/star-warp/package.json	- Updated vite dependency to catalog reference - Added @astrojs/starlight as optional peer dependency - Added astro peer dependency with catalog reference
pnpm-workspace.yaml	Updated Starlight version constraint to '>=0.29 <0.32'
docs/CHANGELOG.md	File removed
docs/src/content.config.ts	Updated loader method from docsLoader() to glob() with specified parameters

Possibly related PRs

• docs: How Runtime Logger works #184: The changes in the main PR and the retrieved PR are related through modifications made to the docs/astro.config.ts file, specifically involving the configuration and imports, indicating a direct connection in the code.
• [ci] release #188: The changes in the main PR are related to the updates made to the @inox-tools/star-warp package, which is also mentioned in the retrieved PR as having a version bump associated with the Astro Integration Kit.

Suggested labels

documentation, pkg/aik-route-config, pkg/astro-tests, pkg/server-islands

Suggested reviewers

• BryceRussell
• florian-lefebvre
• OliverSpeir

Poem

🐰 Hop, hop, through code so bright,
Star Warp's magic takes its flight!
Configs dance, dependencies sing,
Astro's ecosystem gets its wing!
Compatibility's the rabbit's delight! 🚀

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7ffe851 and ca16412.

⛔ Files ignored due to path filters (1)

• pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

📒 Files selected for processing (7)

• .changeset/kind-trainers-bathe.md (1 hunks)
• docs/CHANGELOG.md (0 hunks)
• docs/astro.config.ts (2 hunks)
• docs/package.json (2 hunks)
• docs/src/content.config.ts (1 hunks)
• packages/star-warp/package.json (1 hunks)
• pnpm-workspace.yaml (2 hunks)

💤 Files with no reviewable changes (1)

• docs/CHANGELOG.md

🚧 Files skipped from review as they are similar to previous changes (6)

• .changeset/kind-trainers-bathe.md
• docs/package.json
• docs/src/content.config.ts
• packages/star-warp/package.json
• docs/astro.config.ts
• pnpm-workspace.yaml

⏰ Context from checks skipped due to timeout of 120000ms (4)

• GitHub Check: Test: Node 22
• GitHub Check: Test: Node 20
• GitHub Check: Lint
• GitHub Check: E2E test

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 06164f4 and a7507f8.

📒 Files selected for processing (1)

• docs/astro.config.ts (3 hunks)

⏰ Context from checks skipped due to timeout of 120000ms (1)

• GitHub Check: E2E test

🔇 Additional comments (2)

docs/astro.config.ts (2)

7-7: LGTM!

The import statement for starlightCoolerCredit is correctly placed alongside other Starlight-related imports.

---

134-143: LGTM!

Both plugin configurations look good:

• starlightLinksValidator: Enforcing absolute links helps maintain consistent documentation.
• starlightCoolerCredit: Credit configuration is properly structured with relevant Astro information.