Skip to content

chore(docs): update skill documentation and remove outdated instructions #150

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wax911 merged 1 commit into from
May 25, 2026
Merged

chore(docs): update skill documentation and remove outdated instructions #150

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
0 .github/skills/docs-research/SKILL.md → .agent/skills/docs-research/SKILL.md
View file
Open in desktop
File renamed without changes.
0 ...lls/hive-gateway-otel-enrichment/SKILL.md → ...lls/hive-gateway-otel-enrichment/SKILL.md
View file
Open in desktop
File renamed without changes.
0 ...b/skills/openapi-mesh-supergraph/SKILL.md → ...t/skills/openapi-mesh-supergraph/SKILL.md
View file
Open in desktop
File renamed without changes.
0 ...lls/supergraph-change-validation/SKILL.md → ...lls/supergraph-change-validation/SKILL.md
View file
Open in desktop
File renamed without changes.
38 changes: 0 additions & 38 deletions .github/instructions/copilot-instructions.md
View file
Open in desktop

This file was deleted.

26 changes: 15 additions & 11 deletions AGENT.md → AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,4 @@
# AGENT.md

Agent-agnostic contributor guide for `edge-graphql`.

This document is intended for any coding assistant (or human contributor) working in this repository.

## 1) Mission and boundaries
# AGENTS.md

This project exposes a GraphQL endpoint by composing an OpenAPI contract into a supergraph and serving it via Hive Gateway.

Expand All @@ -13,6 +7,12 @@ Primary boundary:
- **Source of truth**: `swagger-spec.json`, `mesh.config.ts`, `gateway.config.ts`
- **Generated artifact**: `supergraph.graphql` (regenerate, do not hand-edit)

## 1) Fast orientation
- Stack: Node `24.16.0` (`.nvmrc`), ESM TypeScript config (`tsconfig.json`), Hive Gateway + GraphQL Mesh Compose + OpenAPI.
- Source of truth for API surface: `swagger-spec.json`.
- Generated artifact: `supergraph.graphql` (always regenerate via scripts; never hand-edit).
- Runtime wiring lives in `mesh.config.ts`, `gateway.config.ts`, and `telemetry.ts`.

## 2) Ground-truth files (read first)

- `README.md` — architecture + workflows
Expand Down Expand Up @@ -80,9 +80,13 @@ If Context7 is unavailable in the execution environment, use official vendor doc

## 7) Local skills in this repository

- `.github/skills/docs-research/SKILL.md`
- `.github/skills/openapi-mesh-supergraph/SKILL.md`
- `.github/skills/hive-gateway-otel-enrichment/SKILL.md`
### Skills

- Use `.agent/skills/docs-research/SKILL.md` for external documentation discovery.
- Use `.agent/skills/openapi-mesh-supergraph/SKILL.md` for OpenAPI → Mesh → supergraph change flow.
- Use `.agent/skills/supergraph-change-validation/SKILL.md` to validate composed output and runtime alignment.
- Use `.agent/skills/hive-gateway-otel-enrichment/SKILL.md` for OpenTelemetry enrichment changes.
- Docs research should prioritize Context7 first, then official vendor docs when Context7 is unavailable.

Use these skills to keep changes consistent and repeatable.

Expand All @@ -91,4 +95,4 @@ Use these skills to keep changes consistent and repeatable.
- No manual edits to generated artifacts without regeneration
- README/docs reflect actual current behavior
- Tests/lint/typecheck pass
- Any telemetry/config changes include env var notes
- Any telemetry/config changes include env var notes