Skip to content

Commit d7b8a65

Browse files
committed
docs: add 18 missing guides to docs/guides/README.md index
1 parent c5ccc92 commit d7b8a65

1 file changed

Lines changed: 108 additions & 0 deletions

File tree

docs/guides/README.md

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,66 @@ Standardized module loading pattern specification:
1818

1919
**When to use**: When implementing or using module loading patterns.
2020

21+
#### [Fragment Command Access](FRAGMENT_COMMAND_ACCESS.md)
22+
23+
How to access commands and functions defined inside profile fragments.
24+
25+
**When to use**: When a function defined in a fragment is not visible in your session.
26+
27+
#### [Fragment Cache Usage](FRAGMENT_CACHE_USAGE.md)
28+
29+
How the SQLite-backed fragment cache works and how to interact with it.
30+
31+
**When to use**: When working with fragment parsing, caching, or cache invalidation.
32+
33+
#### [Fragment Cache Refactoring](FRAGMENT_CACHE_REFACTORING.md)
34+
35+
Analysis and plan for refactoring the `FragmentCache.psm1` module.
36+
37+
**When to use**: When modifying or extending the fragment cache system.
38+
39+
#### [Fragment Loading Optimization](FRAGMENT_LOADING_OPTIMIZATION.md)
40+
41+
Strategies for optimizing fragment load times.
42+
43+
**When to use**: When investigating slow profile startup or fragment loading.
44+
45+
#### [Profile Fragment Loader Modularization](PROFILE_FRAGMENT_LOADER_MODULARIZATION.md)
46+
47+
Analysis of `ProfileFragmentLoader.psm1` modularization opportunities.
48+
49+
**When to use**: When refactoring or extending the profile fragment loader.
50+
51+
#### [Modularization Analysis](MODULARIZATION_ANALYSIS.md)
52+
53+
Identifies monolithic files that could benefit from modularization.
54+
55+
**When to use**: When planning large refactors or splitting oversized files.
56+
57+
#### [Module Documentation Template](MODULE_DOCUMENTATION_TEMPLATE.md)
58+
59+
Standardized template for documenting PowerShell profile modules.
60+
61+
**When to use**: When writing new module documentation.
62+
63+
#### [Preference-Aware Install Hints](PREFERENCE_AWARE_INSTALL_HINTS.md)
64+
65+
How the preference-aware install hint system works.
66+
67+
**When to use**: When adding new tool install hints or customizing hint output.
68+
69+
#### [Preference Awareness Implementation](PREFERENCE_AWARENESS_IMPLEMENTATION.md)
70+
71+
Summary of all places where preference-awareness is implemented.
72+
73+
**When to use**: When auditing or extending preference-aware behavior.
74+
75+
#### [SQLite Databases](SQLITE_DATABASES.md)
76+
77+
Overview of SQLite databases used for persistent storage in the profile.
78+
79+
**When to use**: When working with fragment cache, metrics history, or other persistent data.
80+
2181
### Testing
2282

2383
#### [Testing Guide](TESTING.md)
@@ -44,6 +104,12 @@ Advanced developer guide covering:
44104

45105
**When to use**: When writing tests, debugging test failures, or working on the test infrastructure.
46106

107+
#### [Development Quick Start](DEVELOPMENT_QUICK_START.md)
108+
109+
Quick reference for developers — fast profile loading, common commands, and setup shortcuts.
110+
111+
**When to use**: When onboarding to the project or quickly orienting to the development workflow.
112+
47113
#### [Test Verification Mocking Guide](TEST_VERIFICATION_MOCKING_GUIDE.md)
48114

49115
Guide for using mocking frameworks in tests.
@@ -64,6 +130,12 @@ Documentation of tool requirements for tests.
64130

65131
### Code Quality
66132

133+
#### [Error Handling Standard](ERROR_HANDLING_STANDARD.md)
134+
135+
Standardized error handling approach, including `Write-StructuredError`, color coding conventions, and catch-block patterns.
136+
137+
**When to use**: When adding error handling to fragments, modules, or scripts.
138+
67139
#### [Function Naming Exceptions](FUNCTION_NAMING_EXCEPTIONS.md)
68140

69141
List of functions that don't follow standard PowerShell naming conventions and the reasons why.
@@ -76,6 +148,30 @@ Security scanning allowlist for PSScriptAnalyzer rules that are intentionally su
76148

77149
**When to use**: When adding new security suppressions or reviewing security configurations.
78150

151+
#### [Type Safety Guide](TYPE_SAFETY.md)
152+
153+
Strategies for improving type safety in PowerShell codebases.
154+
155+
**When to use**: When adding enums, classes, or type-validated parameters.
156+
157+
#### [Type Safety Implementation Summary](TYPE_SAFETY_IMPLEMENTATION_SUMMARY.md)
158+
159+
Summary of implemented type safety improvements.
160+
161+
**When to use**: Understanding what type safety improvements are already in place.
162+
163+
#### [Type Safety Migration Status](TYPE_SAFETY_MIGRATION_STATUS.md)
164+
165+
Tracks the migration from backward-compatible enum usage to direct enum usage.
166+
167+
**When to use**: When continuing or auditing the type safety migration.
168+
169+
#### [Type Safety Remaining Improvements](TYPE_SAFETY_REMAINING_IMPROVEMENTS.md)
170+
171+
Outlines additional type safety improvements that could be implemented.
172+
173+
**When to use**: When planning future type safety work.
174+
79175
### Performance
80176

81177
#### [Profile Performance Optimization](PROFILE_PERFORMANCE_OPTIMIZATION.md)
@@ -84,12 +180,24 @@ Detailed performance optimization guide.
84180

85181
**When to use**: When optimizing profile performance.
86182

183+
#### [Development Performance Optimization](DEVELOPMENT_PERFORMANCE.md)
184+
185+
Performance optimization specifically for developers working on the profile itself.
186+
187+
**When to use**: When profiling or improving the development iteration cycle.
188+
87189
#### [Profile Loading Performance Analysis](PROFILE_LOADING_PERFORMANCE_ANALYSIS.md)
88190

89191
Analysis of profile loading performance.
90192

91193
**When to use**: Understanding profile loading performance.
92194

195+
#### [Profile Load Time Optimization](PROFILE_LOAD_TIME_OPTIMIZATION.md)
196+
197+
Actionable recommendations for improving PowerShell profile load times.
198+
199+
**When to use**: When profile startup is slow and you want concrete fixes.
200+
93201
#### [Parallel Loading State Merge Analysis](PARALLEL_LOADING_STATE_MERGE_ANALYSIS.md)
94202

95203
Technical analysis of parallel loading state merging challenges and alternatives.

0 commit comments

Comments
 (0)