Skip to content

docs(agents): import project docs via @-references - #195

Merged
jdhoffa merged 1 commit into
mainfrom
docs/agents-import-project-docs
Jul 24, 2026
Merged

docs(agents): import project docs via @-references#195
jdhoffa merged 1 commit into
mainfrom
docs/agents-import-project-docs

Conversation

@jdhoffa

@jdhoffa jdhoffa commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Append @ARCHITECTURE.md, @HACKING.md, @CONTRIBUTING.md to AGENTS.md so agents pick them up as context without duplicating content.

Supersedes #166 as a simpler and less intrusive approach; maintaining the core spirit of the originally merged AGENTS.md while giving the robot access to repo-specific development instructions.

In particular, addresses #166 (comment)

We no longer duplicate dev workflow instrcutions (like make targets, etc.), which could risk things falling out of sync.

Copilot AI review requested due to automatic review settings July 24, 2026 12:25
@jdhoffa
jdhoffa requested a review from AlexAxthelm July 24, 2026 12:25

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates AGENTS.md to reference existing repository documentation via @... includes, so agents can pull in repo-specific context without duplicating workflow/architecture content in AGENTS.md.

Changes:

  • Added a new “Project Docs” section to AGENTS.md.
  • Included @ARCHITECTURE.md, @HACKING.md, and @CONTRIBUTING.md as referenced docs.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@github-actions

Copy link
Copy Markdown

CD summary 9195df9

Frontend: https://witty-mushroom-017a3dc1e-195.westus2.1.azurestaticapps.net

Deployments (4)
service url fqdn
api open pr-195-api.purplegrass-c07d0a94.westus2.azurecontainerapps.io
entity-linkage open pr-195-entity-linkage.purplegrass-c07d0a94.westus2.azurecontainerapps.io
frontend https://witty-mushroom-017a3dc1e-195.westus2.1.azurestaticapps.net
stitch-llm open pr-195-stitch-llm.purplegrass-c07d0a94.westus2.azurecontainerapps.io
Database (1)
db_name postgres_host postgres_port postgres_db
pr_195 stitch-dev.postgres.database.azure.com 5432 pr_195
Jobs (2)
job image postgres_db api_url auth_mode
db-migrations ghcr.io/rmi/stitch-api:pr-195@sha256:e9c66445b109224457fb0891decb15b8b38f4c281925188433bb7fdee9c2d3e9 pr_195
seed ghcr.io/rmi/stitch-seed:pr-195@sha256:038accd80603ae5bbee3dcc33670f838da36374b92d4c965ad22cbc356ac639f https://pr-195-api.purplegrass-c07d0a94.westus2.azurecontainerapps.io/api/v1 stitch-client-bearer-token
Images (4)
build_time commit_time git_sha image image_digest
2026-07-24T12:25:44Z 2026-07-24T12:25:29Z fa57416 ghcr.io/rmi/stitch-api:pr-195 ghcr.io/rmi/stitch-api:pr-195@sha256:e9c66445b109224457fb0891decb15b8b38f4c281925188433bb7fdee9c2d3e9
2026-07-24T12:25:46Z 2026-07-24T12:25:29Z fa57416 ghcr.io/rmi/stitch-entity-linkage:pr-195 ghcr.io/rmi/stitch-entity-linkage:pr-195@sha256:dd54a8a5529a77733d04c1e31e9514b5c72b9afe52f191813544ddd32403ac69
2026-07-24T12:25:42Z 2026-07-24T12:25:29Z fa57416 ghcr.io/rmi/stitch-seed:pr-195 ghcr.io/rmi/stitch-seed:pr-195@sha256:038accd80603ae5bbee3dcc33670f838da36374b92d4c965ad22cbc356ac639f
2026-07-24T12:25:42Z 2026-07-24T12:25:29Z fa57416 ghcr.io/rmi/stitch-stitch-llm:pr-195 ghcr.io/rmi/stitch-stitch-llm:pr-195@sha256:62ede68a3ec5baa825173f2de9f2ce9f31621861a8a35e6ec6ba2e482c18016c

@jdhoffa
jdhoffa merged commit 074c9f2 into main Jul 24, 2026
33 checks passed
@jdhoffa
jdhoffa deleted the docs/agents-import-project-docs branch July 24, 2026 12:30
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.

3 participants