Files
mcp-windbg/.github
Sven Scharmentke cd15a7842a docs: restructure the README install flow, and run CI on develop only (#100)
Two changes.

## README: one heading per audience

The install section interleaved three routes - a plugin block, a `pip
install` block for "any other client", then a **Configure your client**
step that circled back to Claude Code. A reader had to work out which
lines applied to them.

Now:

```
## Quick start              tip + prerequisites
## Install in Claude Code
   ### The plugin
   ### Registering the server yourself
## Install in another client
## Start debugging
```

Each path reads top to bottom without branching.

**Python leaves the prerequisites list.** It is not one: the plugin
fetches the server through `uvx`, and the native build will not need it
either. Each route states its own requirement next to the command it
applies to - "Needs uv" for the plugin, "Needs Python 3.10 or higher"
for the two pip routes.

**The enterprise policy tip moves to the top of Quick start.** It can
change whether someone proceeds at all, so it belongs before the
prerequisites rather than buried between install steps.

I left the `Python 3.10+` badge in place - it is accurate metadata for
the PyPI package, and removing it would lose real information for the
pip routes. Say the word if you would rather it went too.

## ci.yml: push trigger drops main and master

```yaml
branches: [ develop ]
```

- `master` does not exist (`git ls-remote --heads origin master` is
empty).
- `main` is moved solely by `fast-forward-main`, a `GITHUB_TOKEN` push,
which by design starts no workflow. The run history confirms it:
**zero** `push main` runs since the migration. Listing it implied a gate
that cannot fire.

`develop` stays, for two reasons that are easy to miss:

1. **The CI badge reads it** (`?branch=develop`). Remove the trigger and
the badge falls back to whatever ran most recently anywhere - which is
how it previously ended up showing "failing" off a blocked release-PR
run.
2. **Merge skew.** PRs are squash-merged with no up-to-date-branch
requirement, so a PR merged while behind `develop` produces a tree
nobody tested. The push run is the only thing that exercises the merged
result.

## Verified

The VS Code JSON snippet parses (it briefly did not - a single-backslash
`C:\Symbols` slipped in, the same defect this repo already shipped once
in the plugin docs), the shell command keeps its single backslash,
`ci.yml` parses with `push branches: [develop]`, and the docs formatter
is clean.
2026-08-27 22:46:18 +02:00
..
2025-12-15 10:58:28 +01:00