Skip to content

Commit 1e71ffa

Browse files
lucaspimentelclaude
andcommitted
docs: fix cross-references after move to docs/
Update all markdown cross-references to point to new locations: - Root files (README, TODO, CLAUDE) now reference docs/ - Files in docs/ use relative paths (./ or ../) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent f3aba30 commit 1e71ffa

File tree

7 files changed

+26
-24
lines changed

7 files changed

+26
-24
lines changed

CLAUDE.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ PowerShell completion module combining Tab completion (NativeAOT) + inline predi
1717

1818
**Supported Commands**: git, gh, gt (Graphite), az, azd, func, code, scoop, winget, wt (Windows Terminal), chezmoi, tre, lsd, dust, cd/Set-Location
1919

20-
For completed work history, see COMPLETED.md.
20+
For completed work history, see docs/COMPLETED.md.
2121

2222
## Architecture
2323
- **ArgumentCompleter** (`pscue-completer.exe`): NativeAOT exe, <10ms startup, computes completions locally with full dynamic arguments support
@@ -152,7 +152,7 @@ Invoke-PCD [path] # Long-form function name
152152
Test-PSCueCompletion -InputString <string> # Test completions
153153
Get-PSCueModuleInfo [-AsJson] # Module diagnostics
154154

155-
# See DATABASE-FUNCTIONS.md for detailed database query examples
155+
# See docs/DATABASE-FUNCTIONS.md for detailed database query examples
156156
```
157157

158158
## Key Technical Decisions
@@ -212,8 +212,8 @@ public void TestLearningAccess()
212212
## Documentation
213213
- **Implementation status**:
214214
- Active work: See `TODO.md` (includes detailed Phase 18 workflow improvements roadmap)
215-
- Completed phases: See `COMPLETED.md` (Phases 1-13, 15, 17.1-17.7, 18.1-18.2 archived)
216-
- **Database functions**: See `DATABASE-FUNCTIONS.md` for detailed SQLite query examples and schema
215+
- Completed phases: See `docs/COMPLETED.md` (Phases 1-13, 15, 17.1-17.7, 18.1-18.2 archived)
216+
- **Database functions**: See `docs/DATABASE-FUNCTIONS.md` for detailed SQLite query examples and schema
217217
- Full details: See `docs/ARCHITECTURE.md` and `docs/TROUBLESHOOTING.md`
218218
- Bug fix history: See git log and commit messages
219219
- API docs: [ICommandPredictor](https://learn.microsoft.com/powershell/scripting/dev-cross-plat/create-cmdlet-predictor), [IFeedbackProvider](https://learn.microsoft.com/powershell/scripting/dev-cross-plat/create-feedback-provider)
@@ -268,5 +268,7 @@ $env:PSCUE_IGNORE_PATTERNS = "aws *,terraform *,*custom-secret*"
268268
- **Release Assets**: PSCue-win-x64.zip, PSCue-linux-x64.tar.gz, checksums.txt
269269
- **Key Features**: Multi-word predictions, dynamic workflow learning, smart directory navigation (pcd)
270270

271+
# Misc
271272
When adding support for new commands, add the completer registration in module/PSCue.psm1
272-
- don't mention TODO phases in code (like "// Add multi-word suggestions (Phase 17.4)")
273+
- don't mention TODO phases in code (like "// Add multi-word suggestions (Phase 17.4)")
274+
- when running ./scripts/install-local.ps1, always use -Force

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -299,7 +299,7 @@ Patterns use wildcards: `*` matches any characters.
299299

300300
PSCue uses a two-component architecture optimized for both speed and intelligence.
301301

302-
> **For detailed technical information**, including caching strategy and implementation notes, see [TECHNICAL_DETAILS.md](TECHNICAL_DETAILS.md).
302+
> **For detailed technical information**, including caching strategy and implementation notes, see [TECHNICAL_DETAILS.md](docs/TECHNICAL_DETAILS.md).
303303
304304
### ArgumentCompleter (Short-lived)
305305
- **Binary**: `pscue-completer.exe` (NativeAOT)
@@ -640,7 +640,7 @@ Write-Host "In memory: $inMemory | In database: $inDb"
640640
- Windows: `%LOCALAPPDATA%\PSCue\learned-data.db`
641641
- Linux: `~/.local/share/PSCue/learned-data.db`
642642

643-
For detailed documentation on database functions, schema, and use cases, see [DATABASE-FUNCTIONS.md](DATABASE-FUNCTIONS.md).
643+
For detailed documentation on database functions, schema, and use cases, see [DATABASE-FUNCTIONS.md](docs/DATABASE-FUNCTIONS.md).
644644

645645
### Workflow Management
646646

@@ -784,9 +784,9 @@ Special thanks to the PowerShell team for the `ICommandPredictor` and `IFeedback
784784
- **Releases**: https://github.com/lucaspimentel/PSCue/releases
785785
- **Project Documentation**:
786786
- [TODO.md](TODO.md) - Current work and future plans
787-
- [COMPLETED.md](COMPLETED.md) - Completed implementation phases (Phases 1-13, 15)
787+
- [COMPLETED.md](docs/COMPLETED.md) - Completed implementation phases (Phases 1-13, 15)
788788
- [CLAUDE.md](CLAUDE.md) - Quick reference for AI agents
789-
- [DATABASE-FUNCTIONS.md](DATABASE-FUNCTIONS.md) - Database query functions and schema
789+
- [DATABASE-FUNCTIONS.md](docs/DATABASE-FUNCTIONS.md) - Database query functions and schema
790790
- **PowerShell API Documentation**:
791791
- [ICommandPredictor API](https://learn.microsoft.com/powershell/scripting/dev-cross-plat/create-cmdlet-predictor)
792792
- [IFeedbackProvider API](https://learn.microsoft.com/powershell/scripting/dev-cross-plat/create-feedback-provider)

TODO.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
**Last Updated**: 2025-11-09
44

5-
This document tracks active and planned work for PSCue. For architectural details, see [TECHNICAL_DETAILS.md](TECHNICAL_DETAILS.md). For completed work, see [COMPLETED.md](COMPLETED.md).
5+
This document tracks active and planned work for PSCue. For architectural details, see [TECHNICAL_DETAILS.md](docs/TECHNICAL_DETAILS.md). For completed work, see [COMPLETED.md](docs/COMPLETED.md).
66

77
---
88

@@ -465,7 +465,7 @@ PS> █ # Press Tab
465465
- ✅ Time delta tracking in database
466466
- ✅ Confidence adjustments based on timing (1.5× to 0.8× boost)
467467

468-
**See**: [COMPLETED.md](COMPLETED.md) for detailed implementation notes
468+
**See**: [COMPLETED.md](docs/COMPLETED.md) for detailed implementation notes
469469

470470
### Phase 18.3: Workflow Chains (3+ Commands)
471471
**Status**: Planned
@@ -1120,11 +1120,11 @@ git push origin main vX.Y.Z
11201120

11211121
### Key Files
11221122
- **Task Tracking**: `TODO.md` (this file)
1123-
- **Architecture**: `TECHNICAL_DETAILS.md`
1123+
- **Architecture**: `docs/TECHNICAL_DETAILS.md`
11241124
- **AI Agent Guide**: `CLAUDE.md`
11251125
- **User Guide**: `README.md`
1126-
- **Database Functions**: `DATABASE-FUNCTIONS.md`
1127-
- **Completed Phases**: `COMPLETED.md`
1126+
- **Database Functions**: `docs/DATABASE-FUNCTIONS.md`
1127+
- **Completed Phases**: `docs/COMPLETED.md`
11281128

11291129
### Build & Test Commands
11301130
```bash
@@ -1163,5 +1163,5 @@ Test-PSCueCompletion, Get-PSCueModuleInfo
11631163
- This is a living document - update as tasks progress
11641164
- Check off items as completed
11651165
- Add new items as discovered
1166-
- Move completed phases to COMPLETED.md
1167-
- Move large architectural details to TECHNICAL_DETAILS.md
1166+
- Move completed phases to docs/COMPLETED.md
1167+
- Move large architectural details to docs/TECHNICAL_DETAILS.md

COMPLETED.md renamed to docs/COMPLETED.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -416,7 +416,7 @@ For current and future work, see [TODO.md](TODO.md).
416416
- [x] Update CLAUDE.md with new tool capabilities
417417
- [x] Update README.md with debugging tool section
418418
- [x] Add examples of using debug tool for troubleshooting
419-
- [x] Document IPC protocol extensions (TECHNICAL_DETAILS.md updated)
419+
- [x] Document IPC protocol extensions (./TECHNICAL_DETAILS.md updated)
420420
- [x] Document IPC server race condition fix
421421
- [x] Document PowerShell process discovery feature
422422

@@ -988,7 +988,7 @@ Features:
988988

989989
- Updated CLAUDE.md with PowerShell function documentation
990990
- Updated README.md with database management examples
991-
- Created DATABASE-FUNCTIONS.md with detailed query examples
991+
- Created ./DATABASE-FUNCTIONS.md with detailed query examples
992992
- Updated installation scripts to copy Functions directory
993993
- Comprehensive help for all 10 functions
994994

@@ -1016,9 +1016,9 @@ Features:
10161016
- test-cache-debug.ps1, test-pscue-debug.ps1
10171017

10181018
**Documentation Updated**:
1019-
- README.md: Removed IPC references, updated architecture diagram
1020-
- TECHNICAL_DETAILS.md: Removed IPC sections, updated key decisions
1021-
- CLAUDE.md: Updated to reflect Phase 16 completion
1019+
- ../README.md: Removed IPC references, updated architecture diagram
1020+
- ./TECHNICAL_DETAILS.md: Removed IPC sections, updated key decisions
1021+
- ../CLAUDE.md: Updated to reflect Phase 16 completion
10221022

10231023
**Verification**:
10241024
- `dotnet build` succeeds (fixed PSCue.slnx folder paths)
@@ -1089,7 +1089,7 @@ Features:
10891089
6. ✅ Direct in-process access (no IPC overhead)
10901090
7. ✅ Export/Import functions enable backup/migration
10911091
8. ✅ All 315 tests passing
1092-
9. ✅ Documentation updated (README, CLAUDE.md, TECHNICAL_DETAILS.md)
1092+
9. ✅ Documentation updated (../README.md, ../CLAUDE.md, ./TECHNICAL_DETAILS.md)
10931093
10. ✅ PSCue.Debug completely removed
10941094
11. ✅ IPC layer completely removed
10951095
12. ✅ 44 IPC tests removed
File renamed without changes.
File renamed without changes.
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -682,7 +682,7 @@ cherry-pick Apply the changes introduced by some existing commits
682682

683683
**References**:
684684
- [PSReadLine #4029](https://github.com/PowerShell/PSReadLine/issues/4029) - Feature request to make timeout configurable
685-
- See `ML-PREDICTIONS.md` for architectural strategies to handle this constraint
685+
- See `./ML-PREDICTIONS.md` for architectural strategies to handle this constraint
686686

687687
**Note:** Simplified architecture provides faster, more reliable performance.
688688

@@ -782,7 +782,7 @@ PSCue works seamlessly across platforms:
782782
**Implication for ML Features**:
783783
- ML predictions in inline suggestions require background pre-computation
784784
- ML predictions in Tab completion can be synchronous (no timeout)
785-
- See `ML-PREDICTIONS.md` for detailed architectural strategies
785+
- See `./ML-PREDICTIONS.md` for detailed architectural strategies
786786

787787
### Project References
788788

0 commit comments

Comments
 (0)