Repository navigation
doc: Refresh stale README.md - #1396
Open
marcleblanc2 wants to merge 1 commit into
Open
marcleblanc2 wants to merge 1 commit into
marcleblanc2 wants to merge 1 commit into
Conversation
marcleblanc2
force-pushed
the
marc/readme-cleanup
branch
2 times, most recently
from
November 3, 2026 23:28
14e8548 to
7b95336
Compare
marcleblanc2
changed the title
marcleblanc2
force-pushed
the
marc/readme-cleanup
branch
from
November 3, 2026 23:48
7b95336 to
df6462f
Compare
The README still pointed readers of Sourcegraph 3.12 or earlier at a 3.11.2-era README, listed a `src extensions` command that no longer exists, and left out commands that have shipped since. Install examples used 3.x versions and only offered amd64 downloads, and the Go Report Card badge now renders "retired" because that service has been sunset. Remove the 3.12 note and the Go Report Card badge. Rebuild the subcommand list from `src help`, sorted alphabetically: drop `extensions`, add `abc`, `codeowners`, `debug`, `lsp`, `search-jobs`, and `snapshot`. Use 8.1.2687 in the versioned install examples and drop the repeated version mentions in the surrounding prose. Default the macOS download to `src_darwin_arm64`, note the `src_linux_arm64` build, fix the `docs/batch_changes` redirect, drop the dead-to-bots computerhope link and the stale Homebrew 3.43.2 note, and tighten the Installation and Docker wording. Point the `src config` error message at the README's "Connect to your Sourcegraph instance" heading; its `#authentication` anchor no longer exists. Add `.markdownlint-cli2.jsonc` so the README lints clean: prose here is not hard-wrapped, the screenshot and the anchor other repos link to need inline HTML, and the per-OS install headings repeat on purpose. Co-authored-by: Amp <amp@ampcode.com> Amp-Thread-ID: https://ampcode.com/threads/T-01a1a3a9-87bc-743d-b475-c96ace107ed5
marcleblanc2
force-pushed
the
marc/readme-cleanup
branch
from
November 3, 2026 23:50
df6462f to
e3c8b1e
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
README cleanup
The subcommand list was out of date (dropped
src extensions;abc,codeowners,debug,lsp,search-jobs, andsnapshotwere missing); rebuilt the list fromsrc helpInstall examples used 3.x versions and amd64-only downloads; updated version number and default macOS to
src_darwin_arm64Go Report Card badge rendered "retired" because the service was sunset
Fixed broken links
Added
.markdownlint-cli2.jsoncsomarkdownlint-cli2 README.mdruns cleanTest Plan
Tested links
go build,go vet,go test ./cmd/src -run Config, andmarkdownlint-cli2 README.mdall pass