layer5io / layer5io/recognition

[Docs] Add AGENTS.md with Sistent design guidance

Open
#118 1 comment 0 reactions 1 assignee View on GitHub

@PARTH-TUSSLE is already working on this.

Since Sep 15, 2026.

area/docs framework/jekyll language/markdown
Dominant language
JavaScript
Stars
23
Forks
15
Avg merge
3h 18m
Merged PRs (30d)
3

Description

Current State

The layer5io/recognition repository does not currently have an AGENTS.md file.
The repository consumes @sistent/sistent@0.15.12, but there is no contributor or AI-agent guidance directing UI-related work to the Sistent design contract.

Desired State

Create a lightweight root-level AGENTS.md documenting basic runbook setup and providing a version-accurate reference to Sistent for UI components.

Guidance Requirements
  • Version Parity: Because the repository is pinned to @sistent/sistent@0.15.12, direct contributors and AI coding agents to read node_modules/@sistent/sistent/DESIGN.md (or link to the matching release tag: https://github.com/layer5io/sistent/tree/v0.15.12/DESIGN.md) rather than master, preventing guidance drift against newer Sistent versions.
  • Single Source of Truth: Instruct agents to consult Sistent's design tokens and conventions before introducing or modifying Sistent-based UI components.
  • Avoid Duplication: Do not copy or create a separate DESIGN.md in this repository.
Scope
  • Create a concise AGENTS.md at the repository root.
  • Include essential project setup/runbook steps.
  • Add the Sistent UI contract pointer under UI guidelines.
  • Keep the file compact and focused.

Contributor Guides and Resources

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.