Skip to content

docs: add preview environments section to contributing guide #2759

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
inkeep wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add preview environments section to contributing guide #2759

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
9 changes: 9 additions & 0 deletions agents-docs/content/community/contributing/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -255,6 +255,15 @@ Types:
- Update documentation as needed
- Ensure CI passes before requesting review

## Preview Environments

Internal PRs automatically receive preview environments backed by Railway (backend) and Vercel (frontend). When a PR is opened or synchronized, CI provisions a full-stack preview:

- **API**: `https://pr-<PR number>-api.preview.inkeep.com`
- **UI**: `https://pr-<PR number>-ui.preview.inkeep.com`

The environment is cloned from `preview-base` and includes all backend services (database, SpiceDB). Smoke tests run automatically to verify the preview is healthy. When the PR is closed, the preview environment is torn down.

## Continuous Integration

Our CI pipeline runs on all pull requests and includes:
Expand Down
Loading