Skip to content

Commit ca69da7

Browse files
authored
Add AGENTS.md (#41)
Signed-off-by: Tamal Saha <tamal@appscode.com>
1 parent 6418a3b commit ca69da7

1 file changed

Lines changed: 29 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# AGENTS.md
2+
3+
This file provides guidance to coding agents (e.g. Claude Code, claude.ai/code) when working with code in this repository.
4+
5+
## Repository purpose
6+
7+
`@bytebuilders/deploy-button` — an embeddable JavaScript widget that renders a "Deploy to ByteBuilders" button on third-party sites (vendor catalogs, docs, demos). Clicking it opens a modal that hands the user off to the ByteBuilders console with the chart/source pre-filled. Built with webpack and shipped as a minified bundle under `dist/`.
8+
9+
## Architecture
10+
11+
- `src/` — widget source (the `DeployButton` class, modal logic, styles).
12+
- `modal.html` — modal template.
13+
- `public/` — static assets.
14+
- `dist/` — built bundle (committed for direct CDN consumption).
15+
- `webpack.config.js` — bundler config.
16+
- `package.json` — npm scripts and dependencies.
17+
18+
## Common commands
19+
20+
- `npm install` — install dependencies.
21+
- `npm run build` — webpack production build → `dist/`.
22+
- (No tests configured.)
23+
24+
## Conventions
25+
26+
- This is an **embeddable widget**, not a SPA. Keep the bundle small and self-contained.
27+
- The bundle is checked into `dist/` so third parties can consume it directly from GitHub; rebuild + commit `dist/` when changing `src/`.
28+
- Don't introduce global state that conflicts with the host page.
29+
- License: see `LICENSE` if present.

0 commit comments

Comments
 (0)