Skip to content

Commit 1927d37

Browse files
docs: remove em dashes and establish writing style guidelines (#980)
- Removed em dashes from mcp-server.mdx and CLAUDE.md - Added Documentation Writing Style section to CLAUDE.md with guidelines for consistency across docs
1 parent f6c7f5c commit 1927d37

File tree

2 files changed

+14
-2
lines changed

2 files changed

+14
-2
lines changed

CLAUDE.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ export const GET = apiHandler(async (request: NextRequest) => {
184184

185185
## Next.js Router Navigation
186186

187-
Do NOT call `router.refresh()` immediately after `router.push()`. In Next.js 16, the prefetch cache and navigation system was completely rewritten, and calling `router.refresh()` right after `router.push()` creates a race condition — the refresh invalidates the cache and can interrupt the in-flight navigation, leaving the page stuck or not loading.
187+
Do NOT call `router.refresh()` immediately after `router.push()`. In Next.js 16, the prefetch cache and navigation system was completely rewritten, and calling `router.refresh()` right after `router.push()` creates a race condition. The refresh invalidates the cache and can interrupt the in-flight navigation, leaving the page stuck or not loading.
188188

189189
```ts
190190
// Bad - router.refresh() races with router.push() in Next.js 16
@@ -197,6 +197,18 @@ router.push(url); // ✅
197197

198198
If you need to refresh server component data after a mutation, use the server-side `refresh()` from `next/cache` in a Server Action instead of `router.refresh()` on the client.
199199

200+
## Documentation Writing Style
201+
202+
When writing or editing `.mdx` files in `docs/`:
203+
204+
- Do NOT use em dashes (``). Use periods to break sentences, commas, or parentheses instead.
205+
- Write in second person ("you") and present tense.
206+
- Keep sentences short and direct. Lead with what the user needs to know.
207+
- Use bold for UI elements and key terms (e.g., **Settings → API Keys**).
208+
- Use inline code for technical values, flags, and identifiers (e.g., `REPO_READ`).
209+
- Prefer short paragraphs (1-3 sentences). Use bullet lists to break up dense information.
210+
- Use tables for parameter documentation.
211+
200212
## Docs Images
201213

202214
Images added to `.mdx` files in `docs/` should be wrapped in a `<Frame>` component:

docs/docs/features/mcp-server.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -281,7 +281,7 @@ Regardless of which method you use, all MCP requests are scoped to the associate
281281

282282
<LicenseKeyRequired feature="OAuth" />
283283

284-
Sourcebot implements an OAuth 2.0 authorization server with support for dynamic client registration (RFC 7591). This means MCP clients can register themselves automatically without any manual setup — just point your client at the MCP endpoint and it will handle the full authorization flow, prompting you to log in and approve access in your browser the first time you connect. No API key or manual token management is required.
284+
Sourcebot implements an OAuth 2.0 authorization server with support for dynamic client registration (RFC 7591). This means MCP clients can register themselves automatically without any manual setup. Just point your client at the MCP endpoint and it will handle the full authorization flow, prompting you to log in and approve access in your browser the first time you connect. No API key or manual token management is required.
285285

286286
Once authorized, Sourcebot issues a short-lived access token (valid for 1 hour) and a refresh token (valid for 90 days). The MCP client handles token refresh automatically, so you stay connected without needing to re-authorize.
287287

0 commit comments

Comments
 (0)