rootiest/fish-config
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add Section 11 — Troubleshooting #83

Merged
rootiest merged 1 commits from docs/add-troubleshooting-section into main 2026-07-27 03:59:44 +00:00
Conversation 0 Commits 1 Files Changed 4
+272 -6
rootiest commented 2026-07-27 03:57:19 +00:00
Owner
Copy Link
Copy Source

Summary

Adds a new Section 11 — Troubleshooting to the manual with 9 concise how-to subsections:

# Subsection Covers
11.1 Uninstalling / Reverting to Backup Restore backup, cleanup generated files and universal variables
11.2 Fish Version Requirement Fish ≥ 4.0 check, upgrade instructions per distro
11.3 Disable Session Logging One-liner + TUI, immediate effect, re-enabling
11.4 Change or Disable the Greeting C6 toggle, custom greeting in local.fish, first-run reset
11.5 Secrets and Machine-Local Config User-dots path verification, TUI, symlink
11.6 Tool Init Does Nothing Return sentinel gotcha — use conf.d/ instead
11.7 Missing Dependencies fish-deps workflow, symptom→cause table
11.8 Vi Mode Keybindings local.fish override vs. full C3 disable
11.9 Minimal Mode Master disable, per-category toggles, config-settings TUI

Each entry is concise how-to style with cross-references to deeper docs (Section 7, 9, 10, etc.).

Renumbers "Viewing This Manual" from Section 11 → 12 so troubleshooting sits before it.

Files Changed

  • docs/manual/11-troubleshooting.md — new
  • docs/manual/11-viewing-this-manual.md → 12-viewing-this-manual.md — renumbered
  • docs/manual/00-table-of-contents.md — updated
  • docs/fish-config.index — 21 new keyword mappings added

Verification Checklist

  • python3 docs/verify-manual.py passes (41/43, 2 pre-existing WARNs)
  • help config troubleshooting opens the new section in the pager
  • help config uninstall jumps to the uninstall subsection
  • help config vi-mode jumps to the Vi mode subsection
  • Doc site builds and renders the new Troubleshooting page with correct sidebar ordering
## Summary Adds a new **Section 11 — Troubleshooting** to the manual with 9 concise how-to subsections: | # | Subsection | Covers | |---|-----------|--------| | 11.1 | Uninstalling / Reverting to Backup | Restore backup, cleanup generated files and universal variables | | 11.2 | Fish Version Requirement | Fish ≥ 4.0 check, upgrade instructions per distro | | 11.3 | Disable Session Logging | One-liner + TUI, immediate effect, re-enabling | | 11.4 | Change or Disable the Greeting | C6 toggle, custom greeting in local.fish, first-run reset | | 11.5 | Secrets and Machine-Local Config | User-dots path verification, TUI, symlink | | 11.6 | Tool Init Does Nothing | Return sentinel gotcha — use conf.d/ instead | | 11.7 | Missing Dependencies | fish-deps workflow, symptom→cause table | | 11.8 | Vi Mode Keybindings | local.fish override vs. full C3 disable | | 11.9 | Minimal Mode | Master disable, per-category toggles, config-settings TUI | Each entry is concise how-to style with cross-references to deeper docs (Section 7, 9, 10, etc.). Renumbers "Viewing This Manual" from Section 11 → 12 so troubleshooting sits before it. ### Files Changed - `docs/manual/11-troubleshooting.md` — **new** - `docs/manual/11-viewing-this-manual.md` → `12-viewing-this-manual.md` — renumbered - `docs/manual/00-table-of-contents.md` — updated - `docs/fish-config.index` — 21 new keyword mappings added ## Verification Checklist - [x] `python3 docs/verify-manual.py` passes (41/43, 2 pre-existing WARNs) - [x] `help config troubleshooting` opens the new section in the pager - [x] `help config uninstall` jumps to the uninstall subsection - [x] `help config vi-mode` jumps to the Vi mode subsection - [x] Doc site builds and renders the new Troubleshooting page with correct sidebar ordering
rootiest added 1 commit 2026-07-27 03:57:21 +00:00
docs: add Section 11 — Troubleshooting 24cdfe4129 
Add a new Troubleshooting section to the manual with 9 concise how-to
subsections covering uninstall/revert, Fish version requirements,
disabling logging, changing the greeting, secrets/local config, the
return sentinel gotcha, missing dependencies, Vi mode keybindings,
and minimal mode.

Renumber Viewing This Manual from Section 11 to Section 12 to place
troubleshooting before it. Update TOC and help index accordingly.

All verify-manual.py checks pass.
rootiest merged commit 0f02def439 into main 2026-07-27 03:59:44 +00:00
rootiest deleted branch docs/add-troubleshooting-section 2026-07-27 03:59:44 +00:00
Sign in to join this conversation.
Reviewers
No Reviewers
Labels
Clear labels
Compat/Breaking
Breaking change that won't be backward compatible
 Kind/Bug
Something is not working
 Kind/Documentation
Documentation changes
 Kind/Enhancement
Improve existing functionality
 Kind/Feature
New functionality
 Kind/Security
This is security issue
 Kind/Testing
Issue or pull request related to testing
Priority
Critical
1
The priority is critical
Priority
High
2
The priority is high
Priority
Low
4
The priority is low
Priority
Medium
3
The priority is medium
Reviewed
Confirmed
1
Issue has been confirmed
Reviewed
Duplicate
2
This issue or pull request already exists
Reviewed
Invalid
3
Invalid issue
Reviewed
Won't Fix
3
This issue won't be fixed
Status
Abandoned
3
Somebody has started to work on this but abandoned work
Status
Blocked
1
Something is blocking this issue or pull request
Status
Need More Info
2
Feedback is required to reproduce issue or to continue work
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
rootiest (Rootiest)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: rootiest/fish-config#83
Delete Branch "docs/add-troubleshooting-section"

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?