Skip to content

Commit 2f0cf08

Browse files
ayhammoudaclaude
andcommitted
docs(readme): address review feedback on Task 1 marker widening
- Block C (First run): add "### After PyPI publishing" heading wrapped in its own marker pair, mirroring Block B's pattern, so today's pre-cleanup reader has a clear signal distinguishing the GitHub-source fence from the post-PyPI canonical fence. - Block E (Diagnostics): add post-cleanup-only intro sentences ("Check the local environment:" / "Validate an existing index:") outside each marker pair, so the post-cleanup README has proper section openings matching the rest of the doc. Addresses Important #1 and #2 from the code-quality review of commit 999e219. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 28c146e commit 2f0cf08

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,10 @@ uvx --from git+https://github.com/ayhammouda/python-docs-mcp-server.git python-d
124124
After PyPI publishing, `uvx python-docs-mcp-server build-index ...` is enough.
125125
<!-- /PRE-PYPI -->
126126

127+
<!-- PRE-PYPI: after the first PyPI publish, drop this "After PyPI publishing" heading so the section reads simply as "## First run" -->
128+
### After PyPI publishing
129+
<!-- /PRE-PYPI -->
130+
127131
```bash
128132
uvx python-docs-mcp-server build-index --versions 3.10,3.11,3.12,3.13,3.14
129133
```
@@ -329,6 +333,8 @@ uvx --from git+https://github.com/ayhammouda/python-docs-mcp-server.git python-d
329333
After PyPI publishing:
330334
<!-- /PRE-PYPI -->
331335

336+
Check the local environment:
337+
332338
```bash
333339
uvx python-docs-mcp-server doctor
334340
```
@@ -348,6 +354,8 @@ uvx --from git+https://github.com/ayhammouda/python-docs-mcp-server.git python-d
348354
After PyPI publishing:
349355
<!-- /PRE-PYPI -->
350356

357+
Validate an existing index:
358+
351359
```bash
352360
uvx python-docs-mcp-server validate-corpus
353361
```

0 commit comments

Comments
 (0)