ilia/punimtag
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Deep-scrub active admin guides #105

Merged
ilia merged 1 commits from docs/deep-scrub into master 2026-08-05 16:40:08 -05:00
Conversation 0 Commits 1 Files Changed 4
+385 -609
ilia commented 2026-08-05 16:05:26 -05:00
Owner
Copy Link
Copy Source

Summary

Scrubs AI-generated tone out of the active admin/ops guides while keeping every fact (commands, paths, ports, URLs) intact:

  • docs/USER_GUIDE.md
  • docs/DEPLOYMENT.md
  • docs/DEPLOY_FROM_SCRATCH.md
  • DEPLOYMENT_CHECKLIST.md

Fixes: bold-colon feature walls turned into normal sentences/tables, Title Case headings switched to sentence case, em dashes removed, rule-of-three feature lists trimmed to plain prose.

Out of scope (left untouched on purpose):

  • Historical scratch docs (PHOTO_VIEWER_*, FIX_*, AUTO_MATCH_AUTOMATION_PLAN, DATABASE_ARCHITECTURE_REVIEW, FIXES_*, RESTRUCTURE_SUMMARY, docs/ADMIN_UX_REVIEW.md)
  • CONTRIBUTING.md and admin-frontend/README.md (already plain, no changes needed)
  • docs/DEPLOY_CPANEL_STEP_BY_STEP.md and docs/INSTALL_PREREQUISITES_CPANEL.md (large, cPanel-specific edge-case runbooks; flagging for a follow-up pass if wanted)

Test plan

  • Skim each rewritten guide against the original to confirm no commands/paths/URLs changed
  • No merge requested; review only
## Summary Scrubs AI-generated tone out of the active admin/ops guides while keeping every fact (commands, paths, ports, URLs) intact: - `docs/USER_GUIDE.md` - `docs/DEPLOYMENT.md` - `docs/DEPLOY_FROM_SCRATCH.md` - `DEPLOYMENT_CHECKLIST.md` Fixes: bold-colon feature walls turned into normal sentences/tables, Title Case headings switched to sentence case, em dashes removed, rule-of-three feature lists trimmed to plain prose. Out of scope (left untouched on purpose): - Historical scratch docs (`PHOTO_VIEWER_*`, `FIX_*`, `AUTO_MATCH_AUTOMATION_PLAN`, `DATABASE_ARCHITECTURE_REVIEW`, `FIXES_*`, `RESTRUCTURE_SUMMARY`, `docs/ADMIN_UX_REVIEW.md`) - `CONTRIBUTING.md` and `admin-frontend/README.md` (already plain, no changes needed) - `docs/DEPLOY_CPANEL_STEP_BY_STEP.md` and `docs/INSTALL_PREREQUISITES_CPANEL.md` (large, cPanel-specific edge-case runbooks; flagging for a follow-up pass if wanted) ## Test plan - [ ] Skim each rewritten guide against the original to confirm no commands/paths/URLs changed - [ ] No merge requested; review only
ilia added 1 commit 2026-08-05 16:05:26 -05:00
Scrub active admin guides for plainer tone
CI / skip-ci-check (pull_request) Successful in 31s
Details
CI / docker-ci (pull_request) Successful in 33s
Details
CI / python-lint (pull_request) Successful in 34s
Details
CI / secret-scan (pull_request) Successful in 38s
Details
CI / admin-unit (pull_request) Successful in 57s
Details
CI / viewer-unit (pull_request) Successful in 1m37s
Details
CI / e2e (pull_request) Successful in 1m56s
Details
31e44cc737 
Rewrite docs/USER_GUIDE.md, docs/DEPLOYMENT.md, docs/DEPLOY_FROM_SCRATCH.md,
and DEPLOYMENT_CHECKLIST.md to drop AI-generated tells: bold-colon feature
walls, Title Case headings, em dashes, and rule-of-three lists. Facts
(commands, paths, ports, URLs) are unchanged. Historical scratch docs
(PHOTO_VIEWER_*, FIX_*, *_REVIEW, *_PLAN, etc.) and the cPanel-specific
runbooks are untouched.
ilia merged commit fc763ab73d into master 2026-08-05 16:40:08 -05:00
Sign in to join this conversation.
Reviewers
No Reviewers
Labels
No items
No labels
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Assignees
Clear assignees
ira (Ira) noam tanyar09 ilia (Ilia)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: ilia/punimtag#105