Skip to content

Commit 9004ec8

Browse files
committed
updated update-docs/SKILL.md
1 parent a0369da commit 9004ec8

File tree

2 files changed

+36
-12
lines changed

2 files changed

+36
-12
lines changed

.claude/skills/update-docs/SKILL.md

Lines changed: 35 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: >
55
Use when you have a product PR URL and need to update docs to match code changes.
66
argument-hint: <github-pr-url-or-number>
77
disable-model-invocation: true
8-
allowed-tools: Read, Write, Edit, Bash(gh *), Bash(git *), Bash(mkdir *), Bash(rm -rf /tmp/ravendb-source), Glob, Grep
8+
allowed-tools: Read, Write, Edit, Bash(gh *), Bash(git *), Bash(mkdir *), Bash(rm -rf /tmp/ravendb-source-*), Glob, Grep
99
---
1010

1111
# Update RavenDB Documentation from Product PR
@@ -27,7 +27,7 @@ Run these commands to gather context without flooding the context window:
2727

2828
```bash
2929
# Get structured PR metadata
30-
gh pr view <NUMBER> --repo ravendb/ravendb --json title,body,labels,state,baseRefName,files,additions,deletions,commits
30+
gh pr view <NUMBER> --repo ravendb/ravendb --json title,body,labels,state,baseRefName,headRefName,files,additions,deletions,commits
3131

3232
# Get list of changed files (no diff content yet)
3333
gh pr diff <NUMBER> --repo ravendb/ravendb --name-only
@@ -44,23 +44,23 @@ Use a blobless clone — it downloads file contents lazily (only when you read t
4444

4545
```bash
4646
# Remove any previous clone
47-
rm -rf /tmp/ravendb-source
47+
rm -rf /tmp/ravendb-source-<NUMBER>
4848

4949
# Blobless clone (fast — file contents downloaded on demand)
50-
git clone --filter=blob:none https://github.com/ravendb/ravendb.git /tmp/ravendb-source
50+
git clone --filter=blob:none https://github.com/ravendb/ravendb.git /tmp/ravendb-source-<NUMBER>
5151

5252
# Checkout the PR branch
53-
cd /tmp/ravendb-source && gh pr checkout <NUMBER>
53+
cd /tmp/ravendb-source-<NUMBER> && gh pr checkout <NUMBER>
5454
```
5555

56-
After cloning, you have **full access** to the entire product codebase at `/tmp/ravendb-source/`.
56+
After cloning, you have **full access** to the entire product codebase at `/tmp/ravendb-source-<NUMBER>/`.
5757
Use `Read`, `Glob`, and `Grep` on this path to:
5858
- Read complete source files (not just diffs)
5959
- Browse related/unchanged code for context (base classes, interfaces, callers)
6060
- Search the entire codebase for patterns, usages, and references
6161
- Read test files for real usage examples and expected behavior
6262

63-
**Important**: The docs repo remains your working directory (`D:\workspaces\docs`). The cloned product repo is read-only reference material at `/tmp/ravendb-source/`.
63+
**Important**: The docs repo remains your working directory (`D:\workspaces\docs`). The cloned product repo is read-only reference material at `/tmp/ravendb-source-<NUMBER>/`.
6464

6565
## Phase 3 — Classify Changes
6666

@@ -138,16 +138,16 @@ Based on the changed files, classify the PR as one or more of:
138138

139139
## Phase 5 — Explore Source Code
140140

141-
After user confirmation, use the cloned repo at `/tmp/ravendb-source/` to deeply understand the changes.
141+
After user confirmation, use the cloned repo at `/tmp/ravendb-source-<NUMBER>/` to deeply understand the changes.
142142

143143
### Read the changed files in full
144144
For each file identified in Phase 2, read the complete source file (not just the diff) to understand the full API surface:
145145
```
146-
Read /tmp/ravendb-source/src/Raven.Client/Documents/Session/SomeNewFeature.cs
146+
Read /tmp/ravendb-source-<NUMBER>/src/Raven.Client/Documents/Session/SomeNewFeature.cs
147147
```
148148

149149
### Browse related code for context
150-
Use `Glob` and `Grep` on `/tmp/ravendb-source/` to find:
150+
Use `Glob` and `Grep` on `/tmp/ravendb-source-<NUMBER>/` to find:
151151
- Base classes, interfaces, and abstract types that changed code extends
152152
- Other callers or usages of the modified API
153153
- Configuration key registrations and default values
@@ -156,7 +156,7 @@ Use `Glob` and `Grep` on `/tmp/ravendb-source/` to find:
156156
### Get a high-level diff overview
157157
Use the base branch from the PR metadata (`baseRefName` from Phase 2) — it may be `v6.2`, `v7.1`, etc., not necessarily `main`:
158158
```bash
159-
cd /tmp/ravendb-source && git diff origin/<BASE_BRANCH>...HEAD --stat
159+
cd /tmp/ravendb-source-<NUMBER> && git diff origin/<BASE_BRANCH>...HEAD --stat
160160
```
161161

162162
### Prioritize reading
@@ -244,7 +244,30 @@ After making changes:
244244

245245
### Clean up the cloned repo
246246
```bash
247-
rm -rf /tmp/ravendb-source
247+
rm -rf /tmp/ravendb-source-<NUMBER>
248+
```
249+
250+
### Commit the changes
251+
252+
The commit message **must** start with an issue number prefix:
253+
- **`RavenDB-XXXXX`** — extract from the PR title, branch name, or body (e.g., PR title "RavenDB-25962 - Add vector search support" → prefix is `RavenDB-25962`)
254+
- **`RDoc-XXXXX`** — if the documentation change has its own tracking issue
255+
256+
To find the issue number, check (in order):
257+
1. The PR title (most common — e.g., "RavenDB-25962 - ...")
258+
2. The PR branch name (e.g., `RavenDB-25962-vector-search`)
259+
3. The PR body/description
260+
261+
**If no issue number can be found**, ask the user to provide either a `RavenDB-XXXXX` or `RDoc-XXXXX` number before committing.
262+
263+
Commit message format:
264+
```
265+
<ISSUE-NUMBER> - <short description of documentation changes>
266+
```
267+
268+
Example:
269+
```
270+
RavenDB-25962 - Document vector search query API and configuration options
248271
```
249272

250273
### Provide a summary

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,4 @@ npm-debug.log*
2121
yarn-debug.log*
2222
yarn-error.log*
2323
/.claude
24+
.vs

0 commit comments

Comments
 (0)