Skip to content

Development environment setup #8

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

Merged
jonathannorris merged 1 commit into from
Feb 25, 2026
Merged

Development environment setup #8

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

## Cursor Cloud specific instructions

This is the **OpenFeature documentation website** built with Docusaurus 3.9. It is a single-product repo (not a monorepo).

### Quick reference

| Action | Command |
|--------|---------|
| Install deps | `yarn install` |
| Init submodules | `git submodule update --init --recursive` (or `yarn submodules`) |
| Dev server | `yarn start` (port 3000) |
| Build | `yarn build` |
| Lint | `yarn lint` (runs ESLint + markdownlint via wireit) |
| Type check | `yarn typecheck` |

### Non-obvious notes

- **Git submodules are required.** The build will fail if `external-content/specification` and `external-content/community` are not initialized. The `yarn start` command (via wireit) automatically runs `git submodule update --init --recursive` as a dependency, but `yarn build` does **not** — run `yarn submodules` first if building directly.
- The `yarn start` wireit task auto-initializes submodules before starting the dev server.
- The `yarn lint` wireit task runs both `lint:es` (ESLint) and `lint:md` (markdownlint-cli2) in parallel.
- `yarn build` has `onBrokenLinks: 'throw'` so broken internal links will cause the build to fail — this acts as a de-facto integration test.
- The Makefile at the repo root is for Docker-based workflows only and is not needed for local development.
- Node.js >= 20 is required (`engines` field in package.json).
- Package manager is Yarn Classic 1.x (specified in `packageManager` field).
Loading