Skip to content

[Docs] Add AGENTS.md with Sistent design guidance - #119

Open
PARTH-TUSSLE wants to merge 2 commits into
layer5io:masterfrom
PARTH-TUSSLE:docs/agents-md-sistent-guidance
Open

PARTH-TUSSLE wants to merge 2 commits into
layer5io:masterfrom
PARTH-TUSSLE:docs/agents-md-sistent-guidance

Conversation

@PARTH-TUSSLE

@PARTH-TUSSLE PARTH-TUSSLE commented Sep 15, 2026

Copy link
Copy Markdown

Notes for Reviewers

Summary

Adds a root-level AGENTS.md to provide operational setup/runbook guidance and a version-accurate reference to Sistent's UI design contract for human contributors and AI coding agents.

Details

  • Runbook: Documents setup, dev server (make site-dev / npm start), build (make build / npm run build), and clean (npm run clean / make clean) commands based on the existing package.json and Makefile.
  • Repository Structure: Documents key functional directories (src/pages, src/sitecomponents, src/badgesInfo.json, static/).
  • UI & Sistent Guidance:
    • Directs contributors/agents to reuse UI primitives from @sistent/sistent.
    • Points agents to node_modules/@sistent/sistent/DESIGN.md (or the Sistent release matching the version resolved in package-lock.json), preventing drift against master.
    • Uses Sistent as the source of truth for Sistent-based UI guidance without duplicating DESIGN.md.
  • Contribution Standards: Documents DCO sign-off and build verification.

This PR fixes #118

Signed commits

  • [✅] Yes, I signed my commits.

Summary by CodeRabbit

  • Documentation
    • Added repository contribution and development guidelines.
    • Documented the technology stack, project structure, development commands, and build verification steps.
    • Added guidance for UI component reuse, design references, and contribution requirements.

Signed-off-by: Parth Gartan <parthgartan26feb@gmail.com>
@github-actions github-actions Bot added area/ci Continuous integration | Build and release component/kanvas-docs labels Sep 15, 2026
@coderabbitai

coderabbitai Bot commented Sep 15, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: a749af81-6e7d-446a-84aa-7c1719960c05

📥 Commits

Reviewing files that changed from the base of the PR and between 54b1ad1 and 78f8abc.

📒 Files selected for processing (1)
  • AGENTS.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • AGENTS.md

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The pull request adds AGENTS.md with repository architecture, development commands, structure, Sistent UI guidance, and contribution requirements.

Changes

Repository Guidance

Layer / File(s) Summary
Repository documentation and contribution workflow
AGENTS.md
Documents the Gatsby and React stack, development commands, repository structure, Sistent component and design guidance, DCO sign-off, pull request targeting, and clean build verification.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to 78f8a

The repository guidance provides the required development and contribution instructions and directs UI work to the matching Sistent design contract. No actionable merge risk remains.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly identifies the documentation change and the added AGENTS.md file. It also names the Sistent design guidance, which is a key objective of the pull request.
Linked Issues check ✅ Passed AGENTS.md is new at the repository root and remains compact. It documents setup, development, build, clean, structure, contribution, and verification steps. It directs contributors and AI coding agent…
Out of Scope Changes check ✅ Passed The whole-PR diff contains only the requested root-level AGENTS.md. Its runbook, repository structure, contribution, and Sistent guidance support the linked documentation objective. No unrelated sourc…
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@github-actions

Copy link
Copy Markdown

@PARTH-TUSSLE
PARTH-TUSSLE requested a lite review from Copilot September 16, 2026 03:36

Copilot AI 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.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

Signed-off-by: Parth Gartan <parthgartan26feb@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/ci Continuous integration | Build and release component/kanvas-docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs] Add AGENTS.md with Sistent design guidance

2 participants