Skip to content

Shorten README and organize detailed user guides - #7

Merged
ashtonian merged 1 commit into
masterfrom
docs/shorten-readme
Oct 15, 2026
Merged

ashtonian merged 1 commit into
masterfrom
docs/shorten-readme

Conversation

@ashtonian

Copy link
Copy Markdown
Owner

The 2,054-line README combined the introduction with nearly every usage guide and reference table. Reduce it to a 109-line entry point with installation, guided setup, discovery previews, an agent-workspace example, and a task-oriented documentation table.

Move detailed setup, discovery, authentication, configuration, reconciliation, backups, archives, workspaces, launchers, scheduling, shell integration, and operations into linked user guides with a documentation index. Preserve all 15 original YAML examples and the other usage examples. Keep the existing spec, security, and release docs, move the package code map into the architecture guide, and consolidate development commands into CONTRIBUTING.md. Update incoming links and the contributor guidance for where configuration tables belong.

Validation:

  • go build ./...
  • go vet ./...
  • go test -race -timeout 5m ./...
  • golangci-lint run --timeout=5m (v2.14.0): zero issues.
  • go run golang.org/x/vuln/cmd/govulncheck@latest ./...: zero reachable vulnerabilities.
  • All 20 end-to-end tests that use local Git repositories and do not require Docker passed.
  • All 195 local links and anchors checked across 22 Markdown files.
  • Shell syntax checked for 30 examples, substituting documentation placeholders before bash -n.
  • Original examples checked for preservation; two development blocks consolidated into the existing contributor commands.
  • gofmt and git diff --check passed.

The Forgejo-backed provider tests require Docker, which is unavailable here; the existing pull-request workflow runs that coverage.

@ashtonian
ashtonian merged commit 00a377a into master Oct 15, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant