Skip to content

Commit afbb178

Browse files
committed
feat: initial vsix.guide documentation site
0 parents  commit afbb178

48 files changed

Lines changed: 15651 additions & 0 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.claude/settings.local.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"permissions": {
3+
"allow": [
4+
"Bash(npm run build:*)",
5+
"Bash(npm run dev:*)"
6+
]
7+
}
8+
}

.gitignore

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Dependencies
2+
node_modules/
3+
4+
# Build output
5+
dist/
6+
7+
# Astro
8+
.astro/
9+
10+
# Environment
11+
.env
12+
.env.*
13+
!.env.example
14+
15+
# IDE
16+
.vscode/
17+
.idea/
18+
*.swp
19+
*.swo
20+
21+
# OS
22+
.DS_Store
23+
Thumbs.db
24+
25+
# Logs
26+
*.log
27+
npm-debug.log*
28+
29+
# Cache
30+
.cache/

COVERAGE.md

Lines changed: 243 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,243 @@
1+
# VS Extension Points - Coverage Audit
2+
3+
## Current Coverage
4+
5+
### Getting Started (6 pages)
6+
- [x] Introduction
7+
- [x] Prerequisites
8+
- [x] First Extension
9+
- [x] Project Structure
10+
- [x] Debugging
11+
- [x] Packaging/Publishing
12+
13+
### Fundamentals (10 pages)
14+
- [x] Overview
15+
- [x] Service Provider
16+
- [x] Packages
17+
- [x] Commands
18+
- [x] Tool Windows
19+
- [x] Editors (basic)
20+
- [x] Options Pages
21+
- [x] Async Services
22+
- [x] TextMate Grammars
23+
- [x] File Icons
24+
25+
### Advanced (7 pages)
26+
- [x] Overview
27+
- [x] MEF Components
28+
- [x] Language Services
29+
- [x] Debugger Integration
30+
- [x] Source Control
31+
- [x] Project Types
32+
- [x] Performance
33+
34+
### Reference (6 pages)
35+
- [x] Services
36+
- [x] Interfaces
37+
- [x] Registry Keys
38+
- [x] VSIX Manifest
39+
- [x] SDK Tools
40+
- [x] Debug GUIDs
41+
42+
---
43+
44+
## MISSING - Editor Extension Points
45+
46+
- [ ] **Completion Providers** - IntelliSense completion sources
47+
- [ ] **Signature Help** - Parameter info tooltips
48+
- [ ] **Quick Info** - Hover tooltips
49+
- [ ] **Light Bulbs / Code Actions** - Suggested actions
50+
- [ ] **Error Tagging** - Squiggles and diagnostics
51+
- [ ] **Brace Matching** - Highlight matching braces
52+
- [ ] **Outlining / Code Folding** - Collapsible regions
53+
- [ ] **Smart Indentation** - Auto-indent behavior
54+
- [ ] **Go To Definition** - F12 navigation
55+
- [ ] **Find All References** - Shift+F12
56+
- [ ] **Peek Definition** - Alt+F12 inline view
57+
- [ ] **CodeLens** - Inline reference counts, test status
58+
- [ ] **Text Adornments** - Decorations on text
59+
- [ ] **Viewport Adornments** - Fixed position decorations
60+
- [ ] **Intra-text Adornments** - Inline UI elements
61+
- [ ] **Editor Margins** - Custom margins (line numbers, etc.)
62+
- [ ] **Selection & Caret** - Track selection changes
63+
- [ ] **Text Structure Navigator** - Word/line navigation
64+
- [ ] **Editor Formatting** - Format document/selection
65+
- [ ] **Undo/Redo** - Custom undo operations
66+
67+
## MISSING - Solution & Projects
68+
69+
- [ ] **Solution Events** - Open, close, build events
70+
- [ ] **Project Events** - Add, remove, rename
71+
- [ ] **Item Templates** - New item wizards
72+
- [ ] **Project Templates** - New project wizards
73+
- [ ] **Project Flavoring** - Extend existing project types
74+
- [ ] **Custom Hierarchy Nodes** - Custom items in Solution Explorer
75+
- [ ] **Solution Folders** - Organize projects
76+
- [ ] **Multi-Targeting** - Target multiple frameworks
77+
- [ ] **Linked Files** - Shared files across projects
78+
- [ ] **Project Properties** - Custom property pages
79+
80+
## MISSING - Menus & Commands
81+
82+
- [ ] **Dynamic Menus** - Runtime-generated menu items
83+
- [ ] **Context Menus** - All context menu locations
84+
- [ ] **Toolbar Customization** - Custom toolbars
85+
- [ ] **Command Filters** - Intercept commands
86+
- [ ] **Keyboard Shortcuts** - Key bindings deep dive
87+
- [ ] **Command Routing** - Command target chain
88+
- [ ] **Priority & Placement** - Menu item ordering
89+
90+
## MISSING - UI Components
91+
92+
- [ ] **Custom Dialogs** - Modal dialogs
93+
- [ ] **Wizards** - Multi-step wizards
94+
- [ ] **Progress Indication** - Progress bars, wait dialogs
95+
- [ ] **Notifications / InfoBars** - Non-modal messages
96+
- [ ] **Status Bar** - Status bar integration
97+
- [ ] **Output Window** - Custom output panes
98+
- [ ] **Error List** - Add errors, warnings, messages
99+
- [ ] **Task List** - Custom tasks and TODO comments
100+
- [ ] **Toolbox** - Add toolbox items
101+
- [ ] **Properties Window** - Property descriptors
102+
- [ ] **Document Well** - Tab customization
103+
- [ ] **Window Layouts** - Save/restore layouts
104+
- [ ] **Start Window** - Customize start experience
105+
106+
## MISSING - Build & Compile
107+
108+
- [ ] **Custom Build Tasks** - MSBuild tasks
109+
- [ ] **Build Events** - Pre/post build hooks
110+
- [ ] **Build Output** - Custom build loggers
111+
- [ ] **IntelliSense Build** - Design-time builds
112+
- [ ] **Code Generators** - T4, Source Generators
113+
114+
## MISSING - Debugging (Deep Dive)
115+
116+
- [ ] **Debug Visualizers** - Custom data visualizers (expand existing)
117+
- [ ] **Expression Evaluators** - Custom EE
118+
- [ ] **Breakpoint Customization** - Custom breakpoint types
119+
- [ ] **Data Tips** - Hover debugging info
120+
- [ ] **Watch Window** - Custom evaluators
121+
- [ ] **Call Stack** - Custom frames
122+
- [ ] **Modules Window** - Module info
123+
- [ ] **Debug Toolbar** - Debug commands
124+
125+
## MISSING - Code Analysis
126+
127+
- [ ] **Roslyn Analyzers** - Diagnostic analyzers
128+
- [ ] **Code Fixes** - Automated fixes
129+
- [ ] **Refactorings** - Code refactoring providers
130+
- [ ] **Live Analysis** - Real-time diagnostics
131+
- [ ] **Suppressions** - Suppress diagnostics
132+
133+
## MISSING - Testing
134+
135+
- [ ] **Test Adapters** - Custom test frameworks
136+
- [ ] **Test Explorer** - Integration with Test Explorer
137+
- [ ] **Code Coverage** - Coverage providers
138+
- [ ] **Live Unit Testing** - LUT integration
139+
140+
## MISSING - Designer Integration
141+
142+
- [ ] **WPF/XAML Designer** - Designer extensibility
143+
- [ ] **WinForms Designer** - Component designers
144+
- [ ] **Custom Designers** - File-specific designers
145+
- [ ] **Property Window** - Custom type editors
146+
- [ ] **Toolbox Integration** - Designer toolbox
147+
148+
## MISSING - Web & Cloud
149+
150+
- [ ] **Web Browser Tool Window** - Embedded browser
151+
- [ ] **Connected Services** - Service references
152+
- [ ] **Publish Profiles** - Deployment
153+
- [ ] **Azure Integration** - Cloud services
154+
155+
## MISSING - Fonts, Colors & Themes
156+
157+
- [ ] **Custom Classifications** - Define new text colors
158+
- [ ] **Font & Color Defaults** - Set default colors
159+
- [ ] **Theme Detection** - Respond to theme changes
160+
- [ ] **High Contrast** - Accessibility support
161+
162+
## MISSING - Packaging & Distribution
163+
164+
- [ ] **VSIX Signing** - Code signing
165+
- [ ] **Extension Dependencies** - Depend on other extensions
166+
- [ ] **Marketplace Categories** - Publishing details
167+
- [ ] **Extension Packs** - Bundle extensions
168+
- [ ] **Private Galleries** - Enterprise distribution
169+
- [ ] **Auto-Update** - Update mechanisms
170+
171+
## MISSING - Miscellaneous
172+
173+
- [ ] **Background Services** - Long-running services
174+
- [ ] **File Change Tracking** - Monitor file changes
175+
- [ ] **Clipboard** - Clipboard integration
176+
- [ ] **Drag and Drop** - DnD in editors/windows
177+
- [ ] **Find & Replace** - Custom find scopes
178+
- [ ] **Bookmarks** - Bookmark integration
179+
- [ ] **Navigate To** - Ctrl+, integration
180+
- [ ] **Call Hierarchy** - Call hierarchy window
181+
- [ ] **Object Browser** - Type browsing
182+
- [ ] **Class View** - Class hierarchy
183+
- [ ] **Code Definition Window** - Definition tracking
184+
- [ ] **Document Outline** - Document structure
185+
- [ ] **Snippet Manager** - Code snippets
186+
- [ ] **Help Integration** - F1 help context
187+
- [ ] **Feedback & Telemetry** - Usage tracking
188+
- [ ] **Licensing** - Extension licensing
189+
190+
---
191+
192+
## Suggested New Structure
193+
194+
### Getting Started (keep as-is, 6 pages)
195+
196+
### Fundamentals (expand to ~20 pages)
197+
- Core: Service Provider, Packages, Commands, Tool Windows, Options Pages, Async Services
198+
- Editor Basics: TextMate Grammars, File Icons, Editor Overview
199+
- UI: Dialogs, Notifications, Status Bar, Output Window, Error List
200+
201+
### Editor Extensions (NEW section, ~15 pages)
202+
- Completion, Signature Help, Quick Info
203+
- Code Actions, Error Tagging, Brace Matching
204+
- Outlining, Go To Definition, Find References
205+
- CodeLens, Adornments, Margins
206+
207+
### Project System (NEW section, ~8 pages)
208+
- Solution Events, Project Events
209+
- Templates, Flavoring, Custom Nodes
210+
- Build Integration
211+
212+
### Code Analysis (NEW section, ~5 pages)
213+
- Roslyn Analyzers, Code Fixes, Refactorings
214+
215+
### Testing (NEW section, ~3 pages)
216+
- Test Adapters, Test Explorer
217+
218+
### Debugging (expand, ~8 pages)
219+
- Visualizers, Expression Evaluators, Breakpoints
220+
221+
### Theming & UI (NEW section, ~5 pages)
222+
- Fonts & Colors, Themes, High Contrast
223+
224+
### Advanced (keep/expand, ~10 pages)
225+
- Language Services, Source Control, Project Types, Performance
226+
- Designer Integration, Web Integration
227+
228+
### Reference (expand, ~10 pages)
229+
- Services, Interfaces, Registry, Manifest, GUIDs
230+
- Context Menu IDs, Command IDs, UI Contexts
231+
232+
---
233+
234+
## Priority Order
235+
236+
1. Editor Extensions (highest demand)
237+
2. Code Analysis (Roslyn)
238+
3. Project System
239+
4. UI Components
240+
5. Build Integration
241+
6. Testing
242+
7. Theming
243+
8. Everything else

astro.config.mjs

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
import { defineConfig } from 'astro/config';
2+
import mdx from '@astrojs/mdx';
3+
import sitemap from '@astrojs/sitemap';
4+
import tailwindcss from '@tailwindcss/vite';
5+
6+
export default defineConfig({
7+
site: 'https://vsix.guide',
8+
output: 'static',
9+
vite: {
10+
plugins: [tailwindcss()]
11+
},
12+
integrations: [
13+
mdx(),
14+
sitemap()
15+
],
16+
markdown: {
17+
shikiConfig: {
18+
theme: 'github-dark',
19+
langs: ['csharp', 'xml', 'json', 'powershell', 'bash'],
20+
wrap: true
21+
}
22+
},
23+
redirects: {
24+
'/docs': '/docs/getting-started/introduction'
25+
}
26+
});

0 commit comments

Comments
 (0)