Skip to content

feat(website): add machine-readable discovery files - #5636

Merged
Astro-Han merged 1 commit into
apache:mainfrom
colaforniaw:issue/5635
Sep 24, 2026
Merged

Astro-Han merged 1 commit into
apache:mainfrom
colaforniaw:issue/5635

Conversation

@colaforniaw

Copy link
Copy Markdown
Contributor

Summary

Add machine-readable discovery files to the Apache Maka website so crawlers and automated readers can find the canonical pages and authoritative project documents.

This change:

  • Adds robots.txt with crawling permission and the absolute sitemap URL.
  • Adds sitemap.xml with only the four canonical English and Chinese pages.
  • Adds llms.txt with the project positioning, website links, and raw Markdown links to authoritative repository documents.
  • Documents the maintenance rules in website/README.md.
  • Adds built-site tests that prevent the entry points and referenced repository documents from drifting.

The root redirect remains excluded from the sitemap because it is already marked noindex.

Closes #5635

Verification

  • npm --workspace @maka/website run test:dist — 13 tests passed.
  • git diff --check — passed.
  • Full repository lint, format, typecheck, and build checks were not run.

AI use

  • No generative tool made a substantive contribution
  • Generative tooling made a substantive contribution

Tool(s) and scope:

OpenAI Codex authored the implementation, tests, and this description.

Checklist

  • Tests cover the change and fail without it
  • Lint, format, typecheck and the affected suites pass locally

Does this PR entail a change in behavior?

  • Yes — the published website now exposes machine-readable discovery entry points
  • No

@github-actions github-actions Bot added the effort/S Under 100 readable lines label Sep 23, 2026
Add robots.txt, sitemap.xml, and llms.txt to expose the canonical site pages and authoritative repository documents to crawlers and automated readers.

Add built-site coverage for the static entry points and document their maintenance rules.

Generated-by: OpenAI Codex
@colaforniaw
colaforniaw marked this pull request as ready for review September 23, 2026 15:35
@github-actions github-actions Bot added effort/M Under 500 readable lines and removed effort/S Under 100 readable lines labels Sep 23, 2026

@Astro-Han Astro-Han left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM.

@Astro-Han
Astro-Han merged commit fef5b93 into apache:main Sep 24, 2026
2 checks passed
@colaforniaw
colaforniaw deleted the issue/5635 branch September 24, 2026 01:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

effort/M Under 500 readable lines

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Make the website easy for crawlers and agents to discover

3 participants