Skip to content

docs: repository - Correct agent and contributor guidance - #17

Open
netlify-coding[bot] wants to merge 1 commit into
mainfrom
agent-repository-021f
Open

netlify-coding[bot] wants to merge 1 commit into
mainfrom
agent-repository-021f

Conversation

@netlify-coding

@netlify-coding netlify-coding Bot commented Oct 3, 2026 •

Copy link
Copy Markdown

Documentation Pull Request

See the organisation’s Automation Governance & Release Strategy. Template and canonical-label conflicts remain noted below.

Linked issues

Relates to GitHub issue #2, the repository documentation follow-up.

Documentation context: TOA-3, verified through the issue’s Linear linkback.

Retained deployment context: TOA-2.

This PR corrects contributor and agent guidance; it does not reimplement the dependency-name fix. These are references, not closing links. No issue is claimed complete.

What changed

Only the two root guidance documents changed. Dependencies, lockfiles, runtime versions, deployment settings, environment variables, workflows, components, guidelines and the changelog were not modified.

Audience & placement

  • Audience: contributors and AI agents.
  • Placement: the two repository-root guidance documents linked above.
  • Root placement remains an owner-confirmation item because project guidelines restrict root Markdown documents.

Preview / Screenshots

Retained references:

Netlify reported the preview ready for head commit f04980a70b87f41158076ef38714df588473d57a.

The existing description attributes the original run to Claude and records a prompt truncated at “deployment fi...”. These remain previously reported information, not independently verified attribution. Missing prompt text has not been reconstructed.

Notes

Base: 76b1528538a9a3658393552c86308ed9a354885d on main.

Head: f04980a70b87f41158076ef38714df588473d57a.

Previously reported validation

The original agent reported Node 24.21.0 and npm 11.19.0 with dependencies already installed. Commands were not independently rerun during this metadata review; that environment does not establish Netlify’s current runtime.

Validation Previously reported result
npm ls --depth=0 Passed
npm run journal:validate Failed: expected journal-content/, absent from the root listing; content is under content/journal/
npm run journal:check-links Failed: same missing directory
node --test against tests/speckit.test.mjs 93 passed, 11 failed; 104 total
Relative-link and anchor checks Passed: 35 links in agent guidance and 19 in contributor guidance

Not performed by the original agent: npm ci, npm run build, npm run dev, type-checking, linting, browser or accessibility checks, or the accordion test, because jsdom was unavailable. The agent reported that validation commands left the working tree unchanged.

Current checks and review evidence

  • Both dependency-validation jobs were skipped; the workflow runs them only for dependency-automation branches.
  • Netlify’s Pages changed, Header rules and Redirect rules checks were neutral.
  • Netlify’s deploy-preview status was successful: “Deploy Preview ready!”.
  • CodeRabbit’s status was successful but reported “Review skipped”. Its comment reports that the bot lacked a review seat. No submitted review was found.
  • The Autopilot comment reports an access/billing problem.

Preview readiness does not establish clean-checkout validation, production routing, completed documentation review or fulfilled issue acceptance criteria.

Outstanding owner decisions

  1. Confirm npm and decide whether to remove pnpm remnants.
  2. Decide whether to pin Node.
  3. Decide the future of the inactive nested Netlify configuration, headers and redirect. Dashboard inactivity remains previously reported.
  4. Validate production SPA routing given the malformed redirect directory.
  5. Resolve BEM/Tailwind guidance.
  6. Resolve import.meta.env guidance.
  7. Decide on test, lint and typecheck scripts and outdated script references.
  8. Resolve journal script/content paths.
  9. Confirm root documentation placement and ATTRIBUTIONS.md versus the guideline spelling Attributions.md. The latter is absent at root; a separate docs/Attributions.md exists.
  10. Confirm changelog requirements. Documentation issue docs: repository - Add agent and contributor guidance #2 has meta:no-changelog; this does not independently establish a PR exemption.
  11. Address broken ../data/README.md references in the guideline index and main guidelines. That target is absent; src/app/data/README.md exists. Guidelines were left untouched.
  12. Confirm active PostCSS configuration: postcss.config.mjs versus src/app/postcss.config.js, which existing guidance reports as referencing unavailable autoprefixer.
  13. Confirm branch-prefix and PR-template conventions. No local template is committed; this description follows the organisation’s documentation template. The current branch agent-repository-021f does not meet the organisation naming pattern or documentation issue’s docs/ requirement. No branch change is proposed.

Metadata-governance findings

  • The live taxonomy requires type:docs. The develop documentation template still uses legacy type:documentation; it is not substituted for the canonical type.
  • Canonical area:documentation is unavailable in this repository. No unrelated area label is substituted.
  • Template instructions mention skip-changelog, while canonical labels define meta:no-changelog and meta:needs-changelog. PR changelog treatment remains pending an explicit decision.
  • No checklist completion is newly certified by this metadata review.

Changelog

No changelog file was changed. The documentation issue’s label does not independently establish a PR-level exemption. These notes describe the documentation changes, not a committed changelog entry.

Added

  • Documented unresolved owner decisions.

Changed

  • Aligned contributor and agent guidance with repository evidence.

Fixed

  • Corrected package-manager, runtime, deployment, script and path guidance.

Removed

  • Unsupported Node 18+ and pnpm-as-current-package-manager instructions.

Checklist (Global DoD / PR)

  • All AC met and demonstrated
  • Tests added/updated (unit/E2E as appropriate) — N/A to this documentation-only diff; no tests changed. Documentation-command validation remains incomplete.
  • Accessibility checklist completed (where relevant): — Runtime UI subchecks are N/A to this diff; documentation clarity and accessibility review remain outstanding.
    • Semantic HTML and heading order verified
    • Keyboard navigation and visible focus states verified
    • ARIA used only where needed
    • Contrast and non-colour cues reviewed (WCAG 2.2 AA)
  • Docs/readme/changelog updated (if user-facing) — AGENTS.md and CONTRIBUTING.md updated; README.md and CHANGELOG.md unchanged. meta:no-changelog is applied.
  • Security checklist completed (where relevant): — Runtime input-validation, output-escaping and privileged-action subchecks are N/A to this diff; secrets/sensitive-data review remains outstanding.
    • Untrusted input validated and sanitised
    • Output escaped for its rendering context
    • Privileged actions enforce nonce and capability checks
    • No secrets/sensitive data introduced; OWASP risks reviewed
  • Code/design reviews approved
  • CI green; linked issues closed; release notes prepared (if shipping)

@netlify

netlify Bot commented Oct 3, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for thisonetimeonacid ready!

Name Link
🔨 Latest commit f04980a
🔍 Latest deploy log https://app.netlify.com/projects/thisonetimeonacid/deploys/6ac09576e92ca40008aa4fc4
😎 Deploy Preview https://deploy-preview-17--thisonetimeonacid.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 Oct 3, 2026 •

Copy link
Copy Markdown
Contributor

Important

Review skipped

This PR was authored by a bot without an assigned CodeRabbit review seat. Ask an organization administrator to assign a seat to the bot. See the seat-assignment guide. After the seat is assigned, request a review again.

⚙️ Run configuration
  • Configuration used: Repository: lightspeedwp/ThisOneTimeOnAcidCom/.coderabbit.yml
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 671cac45-be58-4588-b07c-26b7ab6d1c3c

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@linear-code

linear-code Bot commented Oct 3, 2026

Copy link
Copy Markdown

TOA-2

@coderabbitai

coderabbitai Bot commented Oct 3, 2026

Copy link
Copy Markdown
Contributor

Autopilot could not be updated. Open Coding to check access and billing.

@ashleyshaw ashleyshaw changed the title Complete documentation updates for ThisOneTimeOnAcidCom repository docs: repository - Correct agent and contributor guidance Oct 5, 2026
@ashleyshaw ashleyshaw added lang:md Markdown content/docs priority:minor Nice-to-have / low urgency status:needs-review Awaiting code review meta:no-changelog type:docs labels Oct 5, 2026 — with Linear
@ashleyshaw ashleyshaw added this to the Website v1.0 milestone Oct 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

lang:md Markdown content/docs meta:no-changelog priority:minor Nice-to-have / low urgency status:needs-review Awaiting code review type:docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants