Sign in

Search issue titles and bodies, change requests and comments. Private repositories you cannot read are not included.
vole
Clone

Read only, no credentials:

https://rodent.software/vole.git

Write over SSH with a registered key:

git clone ssh://git@rodent.software:2222/vole.git

A free and open-source forge that lives in your Git repo.

#221

Adopt a shorter tagline and trim the README

merged · by keenan 2d ago · merged into main at f2fd4024 by keenan 2d ago

keenan opened this 2d ago

Why

The first line of the README was longer than it needed to be, and the rest of the page repeated the documentation index and explained details a newcomer does not need before cloning.

What changes

  • The tagline becomes “A forge that lives in your Git repo” in the README, the docs index, the package description, and the built-in landing-page tagline. A new instance shows it without being configured.
  • The package description no longer says CI records live in Git. CI history stays on the instance; what lives in Git is named: code, issues, comments, change requests, reviews, and releases.
  • The README keeps the tagline, five benefits, quick start, contributing, and license, and points at the docs index instead of copying its table. The private repository note is dropped because the accounts guide covers it.
  • Development notes — building, tests, the checks CI runs, and using Vole as a Go library — move to DEVELOPMENT.md.
  • Contributing no longer tells agents to read AGENTS.md.

Checks

  • vole workflow check
  • vole workflow run verify

Discussion (1)

keenan 2d ago

The description above predates two changes to this branch, so read it with these:

  • The README no longer has a quick start. It is the front page: the tagline, the reasons to use Vole, and links to the documentation, contributing, development, and the license. Building and running are in docs/getting-started.md.
  • The browser sign-in setup is gone from the README too. It needs a domain and a certificate, which a first-time reader does not have, and docs/configuration.md and docs/accounts-and-access.md already cover it.

Final shape is 31 lines: tagline, three-sentence intro, five benefits, one paragraph on what Vole is not, and four links.