jessey/rigdoctor
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 59 Wiki Activity

docs: rewrite README to be user-first (install + use) #32

Merged
jessey merged 1 commits from docs/readme-users into main 2026-05-22 13:32:41 +00:00
Conversation 0 Commits 1 Files Changed 1
+94 -117
jessey commented 2026-05-22 13:32:26 +00:00
Owner
Copy Link
Copy Source

Lead with what RigDoctor does, then install (.deb/apt incl. the private-registry
auth.conf.d + trusted=yes notes, and the .run), then usage (GUI/tray/CLI),
requirements, and privacy. Move the dev content (from-source, tests, docs links)
into a short Development section at the end. Drops the stale status/decisions/
repo-layout planning sections from the top.

Co-Authored-By: Claude Opus 4.7 (1M context) noreply@anthropic.com

Lead with what RigDoctor does, then install (.deb/apt incl. the private-registry auth.conf.d + trusted=yes notes, and the .run), then usage (GUI/tray/CLI), requirements, and privacy. Move the dev content (from-source, tests, docs links) into a short Development section at the end. Drops the stale status/decisions/ repo-layout planning sections from the top. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
jessey added 1 commit 2026-05-22 13:32:27 +00:00
docs: rewrite README to be user-first (install + use)
tests / core (pull_request) Successful in 12s
Details
tests / gui-smoke (pull_request) Successful in 29s
Details
2342dd83aa 
Lead with what RigDoctor does, then install (.deb/apt incl. the private-registry
auth.conf.d + trusted=yes notes, and the .run), then usage (GUI/tray/CLI),
requirements, and privacy. Move the dev content (from-source, tests, docs links)
into a short Development section at the end. Drops the stale status/decisions/
repo-layout planning sections from the top.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
jessey scheduled this pull request to auto merge when all checks succeed 2026-05-22 13:32:31 +00:00
jessey merged commit e8b84bf046 into main 2026-05-22 13:32:41 +00:00
jessey deleted branch docs/readme-users 2026-05-22 13:32:42 +00:00
Sign in to join this conversation.
Reviewers
No Reviewers
Labels
Clear labels
Improvement
Improvement suggestions on existing functionality
 bug
Something is not working
 duplicate
This issue or pull request already exists
 enhancement
New feature
 help wanted
Need some help
 invalid
Something is wrong
 question
More information is needed
 wontfix
This won't be fixed
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
jessey
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: jessey/rigdoctor#32
Delete Branch "docs/readme-users"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?