AGENTS.md

1## Engineering Workflow
2 
3### Install
4- `bun install` (see [bun install](https://bun.sh/docs/cli/install?utm_source=openai))
5 
6### Build
7- `bun run build` (see [bun run](https://bun.sh/docs/cli/run?utm_source=openai))
8 
9### Development
10- `bun run dev` (see [bun run](https://bun.sh/docs/cli/run?utm_source=openai))
11 
12### Type Check
13- `bun run types:check` (see [bun run](https://bun.sh/docs/cli/run?utm_source=openai))
14 
15## Dependency Guide
16 
17- **Overview**: Full dependency descriptions are maintained in `dependencies_overview.md`.
18- **Usage**: Keep this section concise and treat `dependencies_overview.md` as the source-of-truth dependency catalog.
19 
20## Business Logic Domain
21 
22The data models describe a documentation website’s content and presentation metadata. They cover configurable announcement banners (messaging, links, variants), changelog entries for product releases (titles, versions, dates, and GitHub release references), and SEO options for pages (title, description, path, and type). Overall, the domain centers on managing a docs site’s release communications, user-facing announcements, and search visibility.
23 
24Key data models:
25- `src/lib/banner-config.ts`: Announcement banner configuration (messaging, link metadata, and visual variants).
26- `src/lib/changelog-utils.ts`: Structured changelog entries (titles, versions, dates, and GitHub release references).
27- `src/lib/seo.ts`: SEO metadata for pages (title, description, path, and page type).
28 
29Reference details: see `business_logic_references.md`.
30 
31<!-- UNOPLAT_CODE_CONFLUENCE_CONTEXT:BEGIN -->
32<CRITICAL_INSTRUCTION>
33 
34> Generated from branch `dev` at commit `5ecdba39d57f50c5188a8e32b9dd4f52d01611fe` (2026-07-18). Content may become stale as new commits land.
35 
36</CRITICAL_INSTRUCTION>
37 
38## Engineering Workflow
39### Install
40- `bun install` (working directory: repo root; config: `package.json`)
41 
42### Build
43- `bun run build` (working directory: repo root; config: `package.json`)
44 
45### Dev
46- `bun run dev` (working directory: repo root; config: `package.json`)
47 
48### Test
49- `vp test` (working directory: repo root; config: `vite.config.ts`; requires the Vite+ `vp` CLI)
50 
51### Lint
52- `vp check` (working directory: repo root; config: `vite.config.ts`; runs Vite+ validation including linting; requires the Vite+ `vp` CLI)
53 
54### Type Check
55- `bun run types:check` (working directory: repo root; config: `package.json`)
56 
57## Dependency Guide
58See [`dependencies_overview.md`](./dependencies_overview.md) for the full dependency catalog and usage notes.
59 
60## Business Domain
61### Description
62 
63This repository supports the documentation site for Unoplat Code Confluence, a developer tooling product for AI-assisted code understanding and AGENTS.md generation. The data models center on docs-site concerns such as release changelogs, announcement banners, SEO metadata, and framework catalog entries, alongside reusable data-table filtering utilities. The overall domain is product documentation and release communication for a code-context engine aimed at Python and TypeScript codebases.
64 
65### References
66 
67See [`business_domain_references.md`](./business_domain_references.md) for the supporting source references used to derive this domain summary.
68 
69## App Interfaces
70See [`app_interfaces.md`](./app_interfaces.md) for the canonical interface and endpoint reference.
71 
72## Architecture
73See [`architecture.md`](./architecture.md) for the canonical system architecture diagram.
74 
75<!-- UNOPLAT_CODE_CONFLUENCE_CONTEXT:END -->
76 
77<!--VITE PLUS START-->
78 
79# Using Vite+, the Unified Toolchain for the Web
80 
81This project is using Vite+, a unified toolchain built on top of Vite, Rolldown, Vitest, tsdown, Oxlint, Oxfmt, and Vite Task. Vite+ wraps runtime management, package management, and frontend tooling in a single global CLI called `vp`. Vite+ is distinct from Vite, and it invokes Vite through `vp dev` and `vp build`. Run `vp help` to print a list of commands and `vp <command> --help` for information about a specific command.
82 
83Docs are local at `node_modules/vite-plus/docs` or online at https://viteplus.dev/guide/.
84 
85## Review Checklist
86 
87- [ ] Run `vp install` after pulling remote changes and before getting started.
88- [ ] Run `vp check` and `vp test` to format, lint, type check and test changes.
89- [ ] Check if there are `vite.config.ts` tasks or `package.json` scripts necessary for validation, run via `vp run <script>`.
90- [ ] If setup, runtime, or package-manager behavior looks wrong, run `vp env doctor` and include its output when asking for help.
91 
92<!--VITE PLUS END-->
93