Skip to content

docs: add AGENTS.md with Cursor Cloud setup notes #10

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

Draft
cb-vishaal wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs: add AGENTS.md with Cursor Cloud setup notes #10

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

## Cursor Cloud specific instructions

This repository is **Chargebee's GitHub organization profile repo**. Its only content is the
profile README that renders on the org's GitHub landing page.

- The entire tracked source is `profile/README.md`, plus a top-level `README.md` symlink → `profile/README.md`.
- There is **no application code, no package manager, no build system, no automated tests, and no services** to run. There are no dependencies to install, so the startup update script is a no-op.
- The "product" is the rendered Markdown page. To preview it locally the way GitHub would render it, convert the Markdown to HTML (e.g. `pip3 install markdown` then a short script using the `markdown` module) and open it in a browser. `markdown` is only a preview convenience and is intentionally not part of the repo.
- Editing work here is limited to Markdown content in `profile/README.md`. After edits, verify the Markdown renders correctly rather than running lint/build/test.