Skip to content

Add AGENTS.md for repository overview and documentation structure #5

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
UdaraWickramarathne wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Add AGENTS.md for repository overview and documentation structure #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8e202c7
Add AGENTS.md for repository overview and documentation structure
UdaraWickramarathne Mar 19, 2026
f5ff104
Add CLAUDE.md for project documentation overview
UdaraWickramarathne Mar 27, 2026
e91613c
chore: update CLAUDE.md to use @AGENTS.md import syntax
UdaraWickramarathne Apr 6, 2026
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
25 changes: 25 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# AGENTS.md

## Repository Overview

This is a **documentation-only repository** for the API Chat VS Code extension. It contains the public-facing documentation (README, images/GIFs), issue/PR templates, and license. The actual VS Code extension source code is maintained separately.

The API Chat extension uses natural language to interact with APIs that have an OpenAPI description, intelligently selecting and calling relevant API resources based on user input in VS Code.

## Repository Structure

- `README.md` — Main documentation for the extension (usage, features, authentication)
- `docs/api-chat-extension/images/` — GIFs and screenshots demonstrating extension features
- `issue_template.md` — WSO2 standard issue template
- `pull_request_template.md` — WSO2 standard PR template
- `LICENSE` — Apache License 2.0

## No Build/Test/Lint

There are no build scripts, test suites, linting configurations, or package managers in this repository. All changes are documentation and image assets.

## Conventions

- Follows WSO2 organizational templates for issues and PRs
- Documentation images are stored as GIFs/PNGs in `docs/api-chat-extension/images/`
- Licensed under Apache 2.0
1 change: 1 addition & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
@AGENTS.md