Skip to content

chore: add AGENTS.md (doc layering) #112

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

Open
vovinacci wants to merge 1 commit into
base: master
Choose a base branch
from
Open

chore: add AGENTS.md (doc layering) #112

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
29 changes: 29 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# tradecloud-docs-api-v2

## Purpose

External-facing API v2 documentation for the TC1 platform. Covers
order, shipment, forecast, connectors, security, support, plus
guides and a checklist.

## Module / Stack

Markdown (likely GitBook-rendered -- see `SUMMARY.md`).

## Build

No build. Authoring is direct in `.md` files. Render via the
hosting tool (GitBook or equivalent).

## Entry Points

- `SUMMARY.md` -- navigation tree
- `api/`, `connectors/`, `forecast/`, `order/`, `shipment/`,
`security/`, `guide/` -- topic dirs
- `checklist.md`, `support.md` -- standalone refs

## Notes

- Public-facing -- review changes for clarity and accuracy.
- Align with `tradecloud-sdk-dotnet` and the API surface in
`tradecloud-microservices`.