Skip to content

Commit 48dbd3e

Browse files
committed
docs: add caution when reading readme
1 parent 1c18b80 commit 48dbd3e

2 files changed

Lines changed: 14 additions & 0 deletions

File tree

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,12 @@ Neovim plugin for running the Codex CLI in an embedded terminal.
1010
- Neovim >= 0.11.0
1111
- `codex` available on your `PATH` (or configure `cmd`)
1212

13+
> [!CAUTION]
14+
> You are reading the `master` branch README. Install and configuration details
15+
> may differ from tagged releases. The current latest release tag is `v0.2.1`.
16+
> For version-accurate instructions, read the README for your target tag from
17+
> [Codeberg releases](https://codeberg.org/yaadata/codex.nvim/releases).
18+
1319
## Install
1420

1521
```lua

docs/contributing.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -327,6 +327,14 @@ docs(project): add LICENSE file
327327
test(core): add resume dual-mode behavior tests
328328
```
329329

330+
### Release Docs Checklist
331+
332+
When cutting a new release tag:
333+
334+
1. Update the warning banner in `README.md` to state the new latest tag.
335+
2. Verify the release reference points to
336+
`https://codeberg.org/yaadata/codex.nvim/releases`.
337+
330338
## Adding a New Command
331339

332340
1. **API function** -- Add the public method in `lua/codex/init.lua` with

0 commit comments

Comments
 (0)