Skip to content

docs(feat): add AI-readable project page#10

Merged
Ducksss merged 2 commits into
mainfrom
PinZheng/geo-ai-readiness-docs
Jun 3, 2026
Merged

docs(feat): add AI-readable project page#10
Ducksss merged 2 commits into
mainfrom
PinZheng/geo-ai-readiness-docs

Conversation

@Ducksss
Copy link
Copy Markdown
Owner

@Ducksss Ducksss commented Jun 3, 2026

Summary

  • Add a GitHub Pages-ready GEO documentation site with canonical metadata, JSON-LD, robots.txt, sitemap.xml, llms.txt, a public audit, and a measurement plan.
  • Add a Pages deploy workflow and a Node regression test that validates crawl directives, structured data, FAQ/schema alignment, package metadata, and deployment wiring.
  • Update README, changelog, and npm metadata so the AI-readable docs are discoverable and included in the package.
  • Harden the fake macOS open helper so app-instance tests run reliably on current macOS.

Rationale

  • codex-profiles needed a concise, crawlable, machine-readable source for AI answers and citations without diluting the CLI-focused README.
  • The new test keeps the GEO surface from drifting as package metadata, schema, FAQ copy, or deployment workflow changes.

Tests

  • make test
  • make lint
  • git diff --check

Notes

  • GitHub Pages may need to be configured to deploy from GitHub Actions if the repository setting is not already enabled.

Summary:
- Add a GitHub Pages-ready GEO documentation site with canonical
  metadata, JSON-LD, robots.txt, sitemap.xml, llms.txt, audit notes,
  and a measurement plan.
- Wire a Pages deployment workflow and a Node-based GEO regression test
  into make test.
- Update README, changelog, and npm metadata so the project page and
  packaged docs are discoverable.
- Adjust the fake macOS open helper to invoke fake app scripts through
  Bash so app-instance tests are reliable on current macOS.

Rationale:
- The project needed a concise, crawlable, machine-readable source for
  AI citation and answer extraction without weakening the existing CLI
  product surface.
- The workflow and tests keep schema, crawl directives, FAQ visibility,
  package metadata, and deployment wiring from drifting.

Tests:
- make test
- make lint
- git diff --check
@Ducksss Ducksss marked this pull request as ready for review June 3, 2026 11:07
@chatgpt-codex-connector
Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

Summary:
- Assert that the Pages docs include the .nojekyll marker.
- Collapse duplicate Unreleased changelog Fixed headings.
- Remove an unsupported upload-pages-artifact input while preserving the
  docs artifact path.

Rationale:
- Code review identified small polish issues in the GEO test and
  changelog structure.
- Checking the official action metadata showed that dotfiles are already
  included by the Pages artifact archive, so the extra input was invalid.

Tests:
- make test
- make lint
- git diff --check
- npm pack --dry-run --json
@Ducksss Ducksss merged commit 62cb653 into main Jun 3, 2026
2 checks passed
@Ducksss Ducksss deleted the PinZheng/geo-ai-readiness-docs branch June 3, 2026 11:20
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.

1 participant