Skip to content

docs: enhance just setup-ai instructions with detailed explanation #13

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

docs: enhance just setup-ai instructions with detailed explanation #13

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
17 changes: 15 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,19 @@ CBORG_API_KEY

### Setup

After setting up env vars:
After running copier and setting up environment variables, run the following command to complete the AI integration setup:

`just -f ai.just setup-ai`
```bash
just -f ai.just setup-ai
```

This command performs two main setup tasks:

1. **AI Agent Configuration** (`setup-ai-instructions`):
- Creates `CLAUDE.md` symlink to `AGENTS.md` for Claude Code instructions
- Creates `.goosehints` symlink to `AGENTS.md` for Goose agent instructions
- Creates `.github/copilot-instructions.md` symlink to `AGENTS.md` for GitHub Copilot instructions

2. **GitHub Repository Setup** (`setup-gh`):
- Adds repository topics for discoverability (`monarchinitiative,ai4curation`)
- Configures repository secrets from your environment variables (PAT_FOR_PR, ANTHROPIC_API_KEY, etc.)