Skip to content

Commit ea2882f

Browse files
committed
docs: add DEFERRED.md to track skipped refactoring work
1 parent 3b4e416 commit ea2882f

1 file changed

Lines changed: 36 additions & 0 deletions

File tree

DEFERRED.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Deferred Work
2+
3+
Items intentionally skipped for future PRs.
4+
5+
---
6+
7+
## PR: feature/docs-overhaul
8+
9+
### 1. Extract shared EndpointHeader component
10+
**Priority:** Low
11+
**Effort:** 30 min
12+
**Files affected:**
13+
- `frontend/src/pages/api/APIRepositoriesPage.tsx`
14+
- `frontend/src/pages/api/APIAnalysisPage.tsx`
15+
- `frontend/src/pages/api/APISearchPage.tsx`
16+
- `frontend/src/pages/api/APIOverviewPage.tsx`
17+
18+
**What:** All 4 API doc pages duplicate the endpoint header markup (colored method badge + path in bordered container). APIRepositoriesPage already has a local `EndpointHeader` component - extract it to `@/components/docs` and reuse.
19+
20+
**Saves:** ~40 lines of duplication
21+
22+
**When to do:** Next time any of these pages need changes, or during a cleanup sprint.
23+
24+
---
25+
26+
### 2. Consolidate navigation data source
27+
**Priority:** Medium
28+
**Effort:** 1-2 hours
29+
**Files affected:**
30+
- `frontend/src/components/docs/DocsSidebar.tsx` (navigation)
31+
- `frontend/src/components/docs/DocsSearch.tsx` (docsPages)
32+
- `frontend/src/components/docs/DocsLayout.tsx` (mobileNavigation)
33+
34+
**What:** Same page list maintained in 3 places. Adding a page requires updating all 3. Extract single `docsNavigation` data source and derive variants from it.
35+
36+
**When to do:** Before adding more doc pages, or if someone forgets to update all 3.

0 commit comments

Comments
 (0)