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

docs: strip gitignored AGENTS/ and JOB-BRIEF-FINDINGS references from code comments #139

Merged
rootiest merged 1 commits from docs/strip-agents-internal-refs into main 2026-09-08 16:59:06 +00:00
Conversation 0 Commits 1 Files Changed 6
+15 -17
rootiest commented 2026-09-08 16:55:43 +00:00
Owner
Copy Link
Copy Source

Comments in tracked files pointed readers at AGENTS/specs/*.md, AGENTS.md, and JOB-BRIEF-FINDINGS.md — all gitignored, transient dev notes that aren't part of the base repo. Anyone cloning the repo without that local AGENTS/ tree would hit a dangling reference.

Rewrote each to be self-contained, or to point at tracked docs (docs/fish-config.md) instead.

Files touched:

  • functions/__fish_config_sync_logging.fish
  • functions/__fish_help_header.fish
  • tests/test-guards.fish
  • tests/test-help.fish
  • completions/tailscale.fish
  • CONTRIBUTING.md

Left functions/agents-init.fish and the generated docs/fish-config.md/.1 alone — their AGENTS/plans, AGENTS/specs mentions describe the real directory structure the tool itself creates, not a pointer to specific transient file content.

Verified with tests/test-guards.fish (66/66) and tests/test-help.fish (4/4) — comment-only changes, both still pass.

Comments in tracked files pointed readers at `AGENTS/specs/*.md`, `AGENTS.md`, and `JOB-BRIEF-FINDINGS.md` — all gitignored, transient dev notes that aren't part of the base repo. Anyone cloning the repo without that local `AGENTS/` tree would hit a dangling reference. Rewrote each to be self-contained, or to point at tracked docs (`docs/fish-config.md`) instead. Files touched: - `functions/__fish_config_sync_logging.fish` - `functions/__fish_help_header.fish` - `tests/test-guards.fish` - `tests/test-help.fish` - `completions/tailscale.fish` - `CONTRIBUTING.md` Left `functions/agents-init.fish` and the generated `docs/fish-config.md`/`.1` alone — their `AGENTS/plans`, `AGENTS/specs` mentions describe the real directory structure the tool itself creates, not a pointer to specific transient file content. Verified with `tests/test-guards.fish` (66/66) and `tests/test-help.fish` (4/4) — comment-only changes, both still pass.
rootiest added 1 commit 2026-09-08 16:55:44 +00:00
docs: strip gitignored AGENTS/ and JOB-BRIEF-FINDINGS references from code comments 9d7cddf758 
Comments in tracked files pointed readers at AGENTS/specs/*.md,
AGENTS.md, and JOB-BRIEF-FINDINGS.md -- all gitignored, transient
dev notes not part of the base repo. Rewrote each to be self-contained
or point at tracked docs (docs/fish-config.md) instead.
rootiest merged commit 8f48120ba9 into main 2026-09-08 16:59:06 +00:00
rootiest deleted branch docs/strip-agents-internal-refs 2026-09-08 16:59:07 +00:00
Sign in to join this conversation.
Reviewers
No Reviewers
Labels
Clear labels
Area/CI
.github/workflows and repository automation
 Area/Completions
completions/ - tab-completion scripts
 Area/Components
The opinionated-component system (C1-C6)
 Area/Config
config.fish and conf.d/ - startup and environment
 Area/Docs
docs/manual/ and the generated manual, man page, and site
 Area/Functions
functions/ - user-facing functions and helpers
 Area/Integrations
integrations/ - third-party tool wiring
 Area/Prompt & Theme
themes/ and prompt appearance
 Area/Scripts
scripts/ - standalone helper scripts
 Area/Tests
tests/ - the syntax lint and functional suite
 Compat/Breaking
Breaking change that won't be backward compatible
 Kind/Bug
Something is not working
 Kind/Chore
Tooling, dependencies, and housekeeping
 Kind/Documentation
Documentation changes
 Kind/Enhancement
Improve existing functionality
 Kind/Feature
New functionality
 Kind/Performance
Makes existing behavior faster or lighter
 Kind/Refactor
Restructures code without changing behavior
 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
good first issue
Well-scoped and self-contained; a good place to start
 help wanted
Maintainer is looking for someone to pick this up
No labels Area/Completions Area/Docs Area/Functions Area/Tests Kind/Documentation
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Assignees
Clear assignees
rootiest (Rootiest)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: rootiest/fish-config#139