Skip to content

docs: correct the README - #36

Merged
avifenesh merged 1 commit into
mainfrom
docs/readme-audit
Oct 31, 2026
Merged

avifenesh merged 1 commit into
mainfrom
docs/readme-audit

Conversation

@avifenesh

@avifenesh avifenesh commented Oct 31, 2026 •

Copy link
Copy Markdown
Contributor

Corrects the README against the code at main (a9b00dd).

  • Astro 5 -> Astro 7. package.json depends on astro ^7.4.2.
  • Deploy URL agent-sh.github.io -> agent-sh.github.io/agent-sh.dev/. The Pages API reports https://agent-sh.github.io/agent-sh.dev/.
  • Base path / -> /agent-sh.dev/ (structure tree and Deployment section). astro.config.mjs sets base: '/agent-sh.dev/'.
  • Dev server URL now includes the base path, localhost:4321/agent-sh.dev/, for the same reason.
  • tokens.css is not the canonical token source. It @imports src/styles/design-system/tokens.css, which calls itself "the single source of truth". Added design-system/ to the tree and corrected the tokens.css line.
  • Added the missing tracked top-level entries: the agent-knowledge submodule (.gitmodules), scripts/ (pre-push hook setup) and public/llms.txt.

Checked and correct: commands table matches package.json scripts, npm run build output to ./dist/ matches deploy.yml, Nav has the Products dropdown, page descriptions match src/pages/*, ORG_ARCHITECTURE.md exists. No Tiyuvta text or sponsor blockquote in this README.


Note

Low Risk
Documentation-only README edits with no runtime or deployment behavior changes.

Overview
Updates README.md so onboarding docs match main: Astro 5 → 7, GitHub Pages URL and base path / → /agent-sh.dev/, and the local dev URL includes that base path.

The Structure tree now lists agent-knowledge/, scripts/, and public/llms.txt, and clarifies that design-system/ (not root tokens.css) is the canonical token source—with tokens.css documented as importing those tokens.

Reviewed by Cursor Bugbot for commit a162353. Configure here.

@cursor

cursor Bot commented Oct 31, 2026

Copy link
Copy Markdown

Bugbot couldn't run - usage limit reached

Bugbot is counted against Cursor usage for this user or team, and this run hit a usage or spend limit.

A user or team admin can review and increase usage limits in the Cursor dashboard.

(requestId: 7d994dd0-6753-49fb-b65b-e41622b6618d)

@revuto-review revuto-review 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.

This is an auto review done by revuto.


Revuto completed the review and found no evidence-backed concerns.

@avifenesh

Copy link
Copy Markdown
Contributor Author

Self-review (fresh context): checked every changed line against a162353. Astro ^7.4.2 (package.json), base '/agent-sh.dev/' (astro.config.mjs), live URL https://agent-sh.github.io/agent-sh.dev/ returns 200, agent-knowledge submodule (.gitmodules), scripts/setup-hooks.sh installs the pre-push hook, public/llms.txt exists, src/styles/design-system/tokens.css calls itself the single source of truth and src/styles/tokens.css imports it. No wrong claims, broken links or commands, or dropped true text. No style breaks in added text. No blocking findings.

@avifenesh
avifenesh merged commit a162353 into main Oct 31, 2026
6 checks passed
@avifenesh
avifenesh deleted the docs/readme-audit branch October 31, 2026 13:13

This branch was previously deployed

1 inactive deployment
github-pages — a162353d Deployed Oct 31, 2026 by avifenesh via deploy #38
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