Skip to content

docs: add sitemap, robots, llm and descriptors to docs - #37

Merged
sean-roberts merged 1 commit into
mainfrom
kh/add-ax-and-discoverability
May 21, 2026
Merged

docs: add sitemap, robots, llm and descriptors to docs#37
sean-roberts merged 1 commit into
mainfrom
kh/add-ax-and-discoverability

Conversation

@khendrikse

@khendrikse khendrikse commented May 21, 2026

Copy link
Copy Markdown
Contributor

Let's make it easier for our friendly agents to find this tool.

Also let's set up workspaces so dependencies install nicely

@netlify

netlify Bot commented May 21, 2026

Copy link
Copy Markdown

Deploy Preview for axisproject ready!

Name Link
🔨 Latest commit e625199
🔍 Latest deploy log https://app.netlify.com/projects/axisproject/deploys/6a0ed9eeb179c400086a028b
😎 Deploy Preview https://deploy-preview-37--axisproject.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@netlify

netlify Bot commented May 21, 2026

Copy link
Copy Markdown

Deploy Preview for axis-docs ready!

Name Link
🔨 Latest commit e625199
🔍 Latest deploy log https://app.netlify.com/projects/axis-docs/deploys/6a0ed9eeace3ec000881a6b0
😎 Deploy Preview https://deploy-preview-37--axis-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai

coderabbitai Bot commented May 21, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

This PR adds SEO and crawler support to the AXIS documentation site. The changes configure Astro's sitemap integration with a site URL and dependency, extend the DocsLayout to include metadata tags (canonical URL, description, Open Graph, Twitter), and introduce public crawler support files (robots.txt and llms.txt). The modifications span configuration, component layout, and static public assets.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main changes: adding sitemap, robots.txt, llms.txt, and canonical URL descriptors to the documentation site.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description check ✅ Passed The pull request description relates to the changeset by mentioning making it easier for agents to find the tool and setting up workspaces, which aligns with the sitemap, robots.txt, and workspace configuration changes.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch kh/add-ax-and-discoverability

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 875da71 and 1a26ea5.

⛔ Files ignored due to path filters (1)
  • src/docs-site/package-lock.json is excluded by !**/package-lock.json
📒 Files selected for processing (5)
  • src/docs-site/astro.config.mjs
  • src/docs-site/package.json
  • src/docs-site/public/llms.txt
  • src/docs-site/public/robots.txt
  • src/docs-site/src/layouts/DocsLayout.astro

Comment thread src/docs-site/src/layouts/DocsLayout.astro Outdated
@khendrikse
khendrikse force-pushed the kh/add-ax-and-discoverability branch from 1a26ea5 to 591f7e4 Compare May 21, 2026 10:00

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

♻️ Duplicate comments (1)
src/docs-site/src/layouts/DocsLayout.astro (1)

18-18: 🛠️ Refactor suggestion | 🟠 Major | ⚡ Quick win

Use Astro.site instead 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 use Astro.site to 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

📥 Commits

Reviewing files that changed from the base of the PR and between 1a26ea5 and 591f7e4.

⛔ Files ignored due to path filters (2)
  • package-lock.json is excluded by !**/package-lock.json
  • src/docs-site/package-lock.json is excluded by !**/package-lock.json
📒 Files selected for processing (6)
  • package.json
  • src/docs-site/astro.config.mjs
  • src/docs-site/package.json
  • src/docs-site/public/llms.txt
  • src/docs-site/public/robots.txt
  • src/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

@khendrikse
khendrikse force-pushed the kh/add-ax-and-discoverability branch from 591f7e4 to e625199 Compare May 21, 2026 10:09
@sean-roberts
sean-roberts merged commit 456cad4 into main May 21, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants