Skip to content

chore(docs): Revise LLM instructions and update version number #2218

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

chore(docs): Revise LLM instructions and update version number #2218

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
12 changes: 6 additions & 6 deletions docs/go/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,14 @@ To locally run Encore apps with databases, you also need to have [Docker](https:

### Optional: Add Encore LLM instructions

To help LLM powered tools like Cursor and GitHub Copilot understand how to use Encore, you can add pre-made instructions to your app.
To help LLM-powered tools like Cursor, Claude Code, Zed, and GitHub Copilot understand how to use Encore, you can select your preferred LLM rule format during app creation using the CLI. Alternatively, you can manually add pre-made instructions to your app by following the steps below.

Download the [go_llm_instructions.txt](https://github.com/encoredev/encore/blob/main/go_llm_instructions.txt) file.

**How to use:**
- Cursor: Rename the file to `.cursorrules`.
- GitHub Copilot: Paste content in `.github/copilot-instructions.md`.
- For other tools, place the file in your app root.
**How to use:**
- Cursor: Rename the file to `.cursorrules`.
- GitHub Copilot: Paste content in `.github/copilot-instructions.md`.
- For other tools, place the file in your app root.

### Build from source
If you prefer to build from source, [follow these instructions](https://github.com/encoredev/encore/blob/main/CONTRIBUTING.md).
Expand All @@ -40,7 +40,7 @@ If you prefer to build from source, [follow these instructions](https://github.c
Check which version of Encore you have installed by running `encore version` in your terminal.
It should print something like:
```shell
encore version v1.28.0
encore version v1.53.4
```

If you think you're on an older version of Encore, you can easily update to the latest version by running
Expand Down