docs: add sitemap, robots, llm and descriptors to docs - #37
Conversation
✅ Deploy Preview for axisproject ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for axis-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughThis PR adds SEO and crawler support to the AXIS documentation site. The changes configure Astro's sitemap integration with a Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@src/docs-site/src/layouts/DocsLayout.astro`:
- Line 18: Replace the hard-coded base URL when building canonicalUrl with the
configured site value: use Astro.site as the base instead of the string
"https://axis.run". Update the expression that constructs canonicalUrl
(currently using new URL(Astro.url.pathname, "https://axis.run").href) to use
Astro.site as the second argument so the canonical URL is derived from
Astro.url.pathname and Astro.site (maintaining existing .href usage).
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: d0fd8967-f573-45bf-8288-90e3870549ef
⛔ Files ignored due to path filters (1)
src/docs-site/package-lock.jsonis excluded by!**/package-lock.json
📒 Files selected for processing (5)
src/docs-site/astro.config.mjssrc/docs-site/package.jsonsrc/docs-site/public/llms.txtsrc/docs-site/public/robots.txtsrc/docs-site/src/layouts/DocsLayout.astro
1a26ea5 to
591f7e4
Compare
There was a problem hiding this comment.
♻️ Duplicate comments (1)
src/docs-site/src/layouts/DocsLayout.astro (1)
18-18: 🛠️ Refactor suggestion | 🟠 Major | ⚡ Quick winUse
Astro.siteinstead of hard-coding the site URL.This issue was already identified in a previous review. The site URL is configured in
astro.config.mjs, so useAstro.siteto avoid duplication and improve maintainability.♻️ Proposed fix
-const canonicalUrl = new URL(Astro.url.pathname, "https://axis.run").href; +const canonicalUrl = new URL(Astro.url.pathname, Astro.site).href;🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@src/docs-site/src/layouts/DocsLayout.astro` at line 18, The canonicalUrl is built using a hard-coded base ("https://axis.run"); update the code that assigns const canonicalUrl in DocsLayout.astro to use the configured site value (Astro.site) as the URL base instead of the literal string, i.e., construct the URL with Astro.url.pathname and Astro.site so the site config in astro.config.mjs is respected and duplication is removed.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Duplicate comments:
In `@src/docs-site/src/layouts/DocsLayout.astro`:
- Line 18: The canonicalUrl is built using a hard-coded base
("https://axis.run"); update the code that assigns const canonicalUrl in
DocsLayout.astro to use the configured site value (Astro.site) as the URL base
instead of the literal string, i.e., construct the URL with Astro.url.pathname
and Astro.site so the site config in astro.config.mjs is respected and
duplication is removed.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 0426ac0d-5d33-4034-bfb8-fd2f452c7749
⛔ Files ignored due to path filters (2)
package-lock.jsonis excluded by!**/package-lock.jsonsrc/docs-site/package-lock.jsonis excluded by!**/package-lock.json
📒 Files selected for processing (6)
package.jsonsrc/docs-site/astro.config.mjssrc/docs-site/package.jsonsrc/docs-site/public/llms.txtsrc/docs-site/public/robots.txtsrc/docs-site/src/layouts/DocsLayout.astro
✅ Files skipped from review due to trivial changes (2)
- src/docs-site/package.json
- src/docs-site/public/llms.txt
591f7e4 to
e625199
Compare
Let's make it easier for our friendly agents to find this tool.
Also let's set up workspaces so dependencies install nicely