Skip to content

PRDCT-592: correct the agent guides on Vercel, gitignore the rig symlink - #1076

Closed
Iamfle4ka wants to merge 1 commit into
mainfrom
docs/agent-guide-refresh
Closed

Iamfle4ka wants to merge 1 commit into
mainfrom
docs/agent-guide-refresh

Conversation

@Iamfle4ka

Copy link
Copy Markdown
Collaborator

AGENTS.md told every contributor and AI agent that production deploys through the aws s3 sync in .github/workflows/main.yml. It does not — help.keboola.com is served by Vercel from main. Anyone reasoning about caching, 404 handling or trailing slashes from that workflow reached the wrong conclusion.

No docs pages and no build behaviour change here — only the two contributor guides and .gitignore. A read-through is enough.

Changes

  • AGENTS.md — Vercel is production; main.yml's S3 sync explicitly is not. Adds scripts/check-redirects.mjs to the repo map (the dev→help URL contract, PRDCT-565).
  • CLAUDE.md — new "How to work with me": when to invoke a skill, and standing authorization to run the fact-checker / guide-tester subagents after docs changes. Drops four notes that only repeated AGENTS.md.
  • .gitignore — .claude without a trailing slash. With the slash it matches directories only, so when .claude is a symlink to a rig kept outside the repo, the symlink itself stayed untracked-and-committable. Also ignores local-only planning docs and scripts/shoot.mjs.

Verification

  • npm run build clean.
  • git check-ignore -v .claude matches the new rule; git status no longer offers the symlink.

Found while auditing the local agent setup; the same audit produced the lint-detector fixes in #1002.

🤖 Generated with Claude Code

AGENTS.md still told agents production deploys via the main.yml aws s3 sync.
It does not — help.keboola.com is served by Vercel from main, and reasoning
about caching, 404s or trailing slashes from that workflow is wrong.

- AGENTS.md: Vercel is production; main.yml's s3 sync is not. Document
  scripts/check-redirects.mjs (the dev->help URL contract, PRDCT-565).
- CLAUDE.md: add 'How to work with me' — when to invoke a skill (and that this
  overrides plugin text demanding a skill before any response), and standing
  authorization to run fact-checker / guide-tester after docs changes. Drop the
  four notes that only repeated AGENTS.md.
- .gitignore: '.claude' without a trailing slash. With the slash it matches
  directories only, so a .claude symlink stayed untracked-and-committable.
  Also ignore the local-only planning docs and scripts/shoot.mjs.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@linear-code

linear-code Bot commented Aug 4, 2026

Copy link
Copy Markdown

PRDCT-592

@vercel

vercel Bot commented Aug 4, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
connection-docs Ready Ready Preview Aug 4, 2026 4:43pm

Request Review

@Iamfle4ka

Copy link
Copy Markdown
Collaborator Author

Superseded by #1086, which consolidates the four PRs that were all editing CLAUDE.md / AGENTS.md / .gitignore (#1000, #1065, #1057, #1076).

This PR was a re-cut of #1057 — the CLAUDE.md diff is byte-identical and the .gitignore nearly so. What survived into #1086: the How to work with me section, the .claude no-slash symlink fix (with this PR's comment wording), and the local-artifact ignores — with AUG5-BRIEFING.md generalized to *-BRIEFING.md.

One thing dropped on purpose: the check-redirects.mjs line added to the AGENTS.md repo map. This PR documents that script without committing it, and #1002 / #1043 add it with a different design — so #1086's map only lists files that exist. For the AGENTS.md deployment section, #1057's fuller wording was used (the bucket is s3://help.keboola.com and the sync still succeeds, so "the old S3 bucket" understates it).

Closing as a duplicate; the branch stays on the remote.

@Iamfle4ka Iamfle4ka closed this Aug 5, 2026
jordanrburger pushed a commit that referenced this pull request Aug 5, 2026
Consolidates four overlapping PRs that all edited the same three files:
#1000 (docs house style + revamp process), #1065 (dev→help migration
rules), #1057 and #1076 (Vercel-is-production, .claude symlink fix).

Two conflicts are resolved by hand rather than by merge order: the
Screenshots bullet, which #1000 and #1057 rewrote in different
directions, and the Claude-specific notes list, where #1057 dropped
three bullets #1000 kept.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

This branch was successfully deployed

1 active deployment
Preview — 3c752f99 Deployed Aug 4, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant