Skip to content

Commit e4181a9

Browse files
committed
docs: update RISKS.md with GitHub issue links and post-v0.2.0 status
- Remove scope creep risk (no longer relevant for established project) - Add GitHub issue links for high/medium priority risks - Mark cross-platform CI testing as [DONE] - Update last updated date to December 18, 2025 - Create tracking issues for performance, security, accessibility, and UX risks
1 parent ae93d45 commit e4181a9

1 file changed

Lines changed: 26 additions & 44 deletions

File tree

RISKS.md

Lines changed: 26 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,11 @@
1616
- [3.1 Visual Confusion with Ghost Text](#31-visual-confusion-with-ghost-text)
1717
- [3.2 Complexity Overwhelming Users](#32-complexity-overwhelming-users)
1818
- [3.3 Compatibility Issues with Other Extensions](#33-compatibility-issues-with-other-extensions)
19-
- [4. Project Management Risks](#4-project-management-risks)
20-
- [4.1 Scope Creep](#41-scope-creep)
21-
-- [5. Adoption & Market Risks](#5-adoption--market-risks)
22-
- [5.1 Low User Adoption](#51-low-user-adoption)
23-
-- [6. Maintenance & Sustainability Risks](#6-maintenance--sustainability-risks)
24-
- [6.1 Dependency Obsolescence](#61-dependency-obsolescence)
25-
- [6.2 Technical Debt Accumulation](#62-technical-debt-accumulation)
19+
- [4. Adoption \& Market Risks](#4-adoption--market-risks)
20+
- [4.1 Low User Adoption](#41-low-user-adoption)
21+
- [5. Maintenance \& Sustainability Risks](#5-maintenance--sustainability-risks)
22+
- [5.1 Dependency Obsolescence](#51-dependency-obsolescence)
23+
- [5.2 Technical Debt Accumulation](#52-technical-debt-accumulation)
2624
- [Risk Monitoring \& Review](#risk-monitoring--review)
2725

2826
This document identifies potential risks to the successful development, deployment,
@@ -95,6 +93,8 @@ limit adoption, especially for non-English speakers or users with disabilities.
9593
- **Impact:** Medium
9694
- **Overall Risk:** Medium
9795

96+
**Related Issue:** [#53 - Accessibility: Add screen reader support and keyboard navigation](https://github.com/main-branch/mkdocs-snippet-lens/issues/53)
97+
9898
**Mitigation Strategies:**
9999

100100
- Follow VS Code accessibility guidelines ([Planned])
@@ -128,11 +128,11 @@ Linux due to different file system conventions.
128128
**Mitigation Strategies:**
129129

130130
- Use VS Code's built-in path utilities (`vscode.Uri`, `path` module) instead of
131-
string manipulation
132-
- Test thoroughly on all three platforms in CI/CD pipeline
133-
- Normalize paths early in processing pipeline
134-
- Handle case-sensitivity differences explicitly
135-
- Document platform-specific behavior where unavoidable
131+
string manipulation ([DONE])
132+
- Test thoroughly on all three platforms in CI/CD pipeline ([DONE])
133+
- Normalize paths early in processing pipeline ([DONE])
134+
- Handle case-sensitivity differences explicitly ([DONE])
135+
- Document platform-specific behavior where unavoidable ([DONE])
136136

137137
**Indicators:**
138138

@@ -149,6 +149,8 @@ VS Code to become unresponsive.
149149
- **Impact:** High
150150
- **Overall Risk:** High
151151

152+
**Related Issue:** [#51 - Performance: Implement file size limits and async loading](https://github.com/main-branch/mkdocs-snippet-lens/issues/51)
153+
152154
**Mitigation Strategies:**
153155

154156
- Implement strict file size limits (`maxFileSize` = 1MB default)
@@ -228,6 +230,8 @@ workspace, exposing sensitive data.
228230
- **Impact:** Critical
229231
- **Overall Risk:** High
230232

233+
**Related Issue:** [#52 - Security: Implement path traversal protection](https://github.com/main-branch/mkdocs-snippet-lens/issues/52)
234+
231235
**Mitigation Strategies:**
232236

233237
- Strict path validation against workspace boundaries
@@ -253,6 +257,8 @@ files outside workspace.
253257
- **Impact:** High
254258
- **Overall Risk:** Medium
255259

260+
**Related Issue:** [#54 - Security: Implement symlink validation and protection](https://github.com/main-branch/mkdocs-snippet-lens/issues/54)
261+
256262
**Mitigation Strategies:**
257263

258264
- Resolve symlinks and validate final target path
@@ -304,6 +310,8 @@ attempt to edit them.
304310
- **Impact:** Low
305311
- **Overall Risk:** Low
306312

313+
**Related Issue:** [#55 - UX: Improve preview visual differentiation and add per-snippet toggles](https://github.com/main-branch/mkdocs-snippet-lens/issues/55)
314+
307315
**Mitigation Strategies:**
308316

309317
- Use strong visual differentiation (italic, faded, subtle border) ([DONE])
@@ -366,35 +374,9 @@ preview extensions) could break functionality.
366374
- Decoration conflicts or visual glitches
367375
- Command palette conflicts
368376

369-
## 4. Project Management Risks
370-
371-
### 4.1 Scope Creep
372-
373-
**Risk:** Adding too many features beyond MVP could delay release and increase
374-
complexity.
375-
376-
- **Likelihood:** High
377-
- **Impact:** Medium
378-
- **Overall Risk:** High
379-
380-
**Mitigation Strategies:**
381-
382-
- Clearly define MVP in Implementation.md
383-
- Defer advanced features (recursive snippets, complex line ranges) to later versions
384-
- Use strict acceptance criteria for new features
385-
- Regular scope reviews during development
386-
- Just say "no" to feature requests that don't align with core value proposition
387-
- Use GitHub Projects to track and prioritize work
388-
389-
**Indicators:**
390-
391-
- Timeline slipping
392-
- Core features incomplete while working on "nice-to-haves"
393-
- Implementation document keeps growing
394-
395-
## 5. Adoption & Market Risks
377+
## 4. Adoption & Market Risks
396378

397-
### 5.1 Low User Adoption
379+
### 4.1 Low User Adoption
398380

399381
**Risk:** MkDocs users may not discover or adopt the extension, limiting its impact.
400382

@@ -417,9 +399,9 @@ complexity.
417399
- Minimal GitHub stars or engagement
418400
- No user feedback or issues filed
419401

420-
## 6. Maintenance & Sustainability Risks
402+
## 5. Maintenance & Sustainability Risks
421403

422-
### 6.1 Dependency Obsolescence
404+
### 5.1 Dependency Obsolescence
423405

424406
**Risk:** Dependencies may become unmaintained or incompatible with future VS Code
425407
versions.
@@ -443,7 +425,7 @@ versions.
443425
- Deprecation warnings
444426
- Compatibility issues with new VS Code versions
445427

446-
### 6.2 Technical Debt Accumulation
428+
### 5.2 Technical Debt Accumulation
447429

448430
**Risk:** Rush to release or poor design decisions could create technical debt that
449431
hampers future development.
@@ -490,4 +472,4 @@ hampers future development.
490472
- Medium risks: Monitor and address as resources allow
491473
- Low risks: Accept and document
492474

493-
**Last Updated:** December 10, 2025
475+
**Last Updated:** December 18, 2025

0 commit comments

Comments
 (0)