|
| 1 | +# Foundry Local Website Cleanup Summary |
| 2 | + |
| 3 | +This document summarizes all changes made to align the Foundry Local website with the actual product capabilities and redirect documentation to Microsoft Learn. |
| 4 | + |
| 5 | +## Date |
| 6 | + |
| 7 | +October 9, 2025 |
| 8 | + |
| 9 | +## Overview |
| 10 | + |
| 11 | +Performed a comprehensive cleanup of marketing claims and documentation links to ensure accuracy and alignment with Foundry Local's actual capabilities as documented in `/docs`. |
| 12 | + |
| 13 | +--- |
| 14 | + |
| 15 | +## Files Modified |
| 16 | + |
| 17 | +### 1. `/src/lib/components/home/features.svelte` |
| 18 | + |
| 19 | +**Changes:** |
| 20 | + |
| 21 | +- **Data Privacy Section (Lines 46-93)** |
| 22 | + - ❌ Removed: "HIPAA, GDPR, and PCI compliant deployments" |
| 23 | + - ❌ Removed: "Complete audit logging and monitoring" |
| 24 | + - ✅ Added: "All processing stays on your device" |
| 25 | + - ✅ Added: "Works in air-gapped environments" |
| 26 | + - ✅ Added: "No telemetry or usage data collection" |
| 27 | + - Updated description to clarify "No data is sent to Microsoft or any external services" |
| 28 | + - Changed link from `/docs/security` to Microsoft Learn |
| 29 | + |
| 30 | +- **Azure Compatibility Section (Lines 95-134)** |
| 31 | + - Changed title from "Seamless Cloud Transition" to "OpenAI-Compatible API" |
| 32 | + - ❌ Removed: "One-click deployment to Azure" |
| 33 | + - ❌ Removed: "Compatible Azure AI REST API endpoints" |
| 34 | + - ✅ Changed focus to: "OpenAI-compatible REST API" |
| 35 | + - ✅ Added: "Python and JavaScript SDKs" |
| 36 | + - ✅ Added: "Compatible with popular AI frameworks" |
| 37 | + - Updated description to focus on API compatibility rather than cloud transition |
| 38 | + - Changed link from `/docs/azure-compatibility` to Microsoft Learn |
| 39 | + |
| 40 | +**Rationale:** The service provides local AI inference with data privacy. Claims about compliance certifications, audit logging, and one-click Azure deployment were not supported by documentation. |
| 41 | + |
| 42 | +--- |
| 43 | + |
| 44 | +### 2. `/src/lib/components/home/hero.svelte` |
| 45 | + |
| 46 | +**Changes:** |
| 47 | + |
| 48 | +- **Line 10:** Changed install command |
| 49 | + - ❌ Before: `curl -sSL https://get.foundrylocal.ai | bash` (placeholder) |
| 50 | + - ✅ After: `winget install Microsoft.FoundryLocal` (actual command) |
| 51 | + |
| 52 | +- **Line 83:** Updated "Get Started" button link |
| 53 | + - ❌ Before: `/docs` |
| 54 | + - ✅ After: `https://learn.microsoft.com/en-us/azure/ai-foundry/foundry-local/get-started` |
| 55 | + |
| 56 | +**Rationale:** The curl command was a placeholder that doesn't exist. The actual installation methods are winget (Windows) and brew (macOS). |
| 57 | + |
| 58 | +--- |
| 59 | + |
| 60 | +### 3. `/src/lib/config.ts` |
| 61 | + |
| 62 | +**Changes:** |
| 63 | + |
| 64 | +- **Site Description (Lines 18-19)** |
| 65 | + - ❌ Before: "Run AI models locally with the power of Microsoft's Azure AI technology. Foundry Local provides a secure, private environment for AI development and inference." |
| 66 | + - ✅ After: "Run AI models locally on your device. Foundry Local provides on-device inference with complete data privacy, no Azure subscription required." |
| 67 | + |
| 68 | +- **Quick Links (Lines 22-25)** |
| 69 | + - Changed "Getting Started" from `/docs` to Microsoft Learn URL |
| 70 | + - Changed "Model Hub" to "GitHub" link |
| 71 | + |
| 72 | +- **Nav Items (Lines 31-42)** |
| 73 | + - Changed "Documentation" link from `/docs` to Microsoft Learn URL |
| 74 | + |
| 75 | +- **Features Array (Lines 57-78)** |
| 76 | + - **Feature 1:** "Local Deployment" → "On-Device Inference" |
| 77 | + - New description emphasizes no cloud dependencies or Azure subscription |
| 78 | + - **Feature 2:** "Model Integration" → "Optimized Performance" |
| 79 | + - New description focuses on ONNX Runtime and hardware acceleration |
| 80 | + - **Feature 3:** "Azure Compatible" → "OpenAI-Compatible API" |
| 81 | + - New description focuses on OpenAI SDK compatibility |
| 82 | + - **Feature 4:** "Developer-First" → "Python & JavaScript SDKs" |
| 83 | + - New description emphasizes available SDKs |
| 84 | + |
| 85 | +- **Promo Config (Lines 80-88)** |
| 86 | + - ❌ Before: "Scale to the cloud when ready" / "seamlessly transition" |
| 87 | + - ✅ After: "Need to scale to the cloud?" / "enterprise-scale AI infrastructure when your project outgrows local deployment" |
| 88 | + |
| 89 | +**Rationale:** Simplified messaging to focus on actual product capabilities: local execution, ONNX optimization, OpenAI compatibility, and available SDKs. |
| 90 | + |
| 91 | +--- |
| 92 | + |
| 93 | +### 4. `/src/lib/components/home/footer.svelte` |
| 94 | + |
| 95 | +**Changes:** |
| 96 | + |
| 97 | +- **Product Links (Lines 19-36)** |
| 98 | + - Documentation: `/docs` → Microsoft Learn URL |
| 99 | + - Model Hub: `/docs/models` → `/models` (internal page kept) |
| 100 | + - Configuration: `/docs/configuration` → "GitHub Repository" (github.com/microsoft/foundry-local) |
| 101 | + - Releases: Kept as-is (GitHub releases page) |
| 102 | + |
| 103 | +- **Resources Links (Lines 38-56)** |
| 104 | + - Examples: `/docs/examples` → GitHub samples directory |
| 105 | + - GitHub: Duplicate removed, replaced with "Support" → GitHub issues |
| 106 | + |
| 107 | +**Rationale:** Removed broken internal docs links, redirected to Microsoft Learn and appropriate GitHub pages. |
| 108 | + |
| 109 | +--- |
| 110 | + |
| 111 | +### 5. New Files Created |
| 112 | + |
| 113 | +#### `/DOCS_INFRASTRUCTURE_README.md` |
| 114 | + |
| 115 | +**Purpose:** Comprehensive documentation of the docs system architecture |
| 116 | + |
| 117 | +**Contents:** |
| 118 | + |
| 119 | +- Overview of the markdown-based docs system |
| 120 | +- Directory structure and file organization |
| 121 | +- How route loading and navigation work |
| 122 | +- Component descriptions (doc-renderer, table-of-contents, sidebar, etc.) |
| 123 | +- Step-by-step instructions for reactivating the docs system |
| 124 | +- Current state and what was changed |
| 125 | +- Dependencies and configuration files |
| 126 | + |
| 127 | +**Rationale:** Preserve institutional knowledge about the docs infrastructure for future reactivation if needed. |
| 128 | + |
| 129 | +#### `/CLEANUP_SUMMARY.md` (this file) |
| 130 | + |
| 131 | +**Purpose:** Document all changes made during this cleanup |
| 132 | + |
| 133 | +--- |
| 134 | + |
| 135 | +## What Was NOT Changed |
| 136 | + |
| 137 | +### Files/Systems Preserved |
| 138 | + |
| 139 | +1. **Docs Routes** (`/src/routes/docs/`) |
| 140 | + - All route files preserved |
| 141 | + - Can still be accessed directly via URL |
| 142 | + - Just not linked from main navigation |
| 143 | + |
| 144 | +2. **Docs Components** (`/src/lib/components/document/`) |
| 145 | + - All doc-specific components intact |
| 146 | + - doc-renderer, table-of-contents, etc. |
| 147 | + - Can be reactivated without code changes |
| 148 | + |
| 149 | +3. **Content Files** (`/src/content/`) |
| 150 | + - All markdown documentation files preserved |
| 151 | + - Ready for future use |
| 152 | + |
| 153 | +4. **Models Page** (`/src/routes/models/`) |
| 154 | + - Kept as-is, still accessible |
| 155 | + - Linked from footer |
| 156 | + |
| 157 | +5. **Promo Card Component** |
| 158 | + - Component intact |
| 159 | + - Only config text updated |
| 160 | + |
| 161 | +--- |
| 162 | + |
| 163 | +## Claims Removed |
| 164 | + |
| 165 | +### Overselling / Unsubstantiated |
| 166 | + |
| 167 | +1. ❌ "HIPAA, GDPR, and PCI compliant deployments" |
| 168 | + - Not documented anywhere in `/docs` |
| 169 | + - Service just runs offline, doesn't guarantee compliance |
| 170 | + |
| 171 | +2. ❌ "Complete audit logging and monitoring" |
| 172 | + - No evidence of this feature in documentation |
| 173 | + - Docs mention "No telemetry" |
| 174 | + |
| 175 | +3. ❌ "One-click deployment to Azure" |
| 176 | + - Not a documented feature |
| 177 | + - No tooling for this exists |
| 178 | + |
| 179 | +4. ❌ "Compatible Azure AI REST API endpoints" |
| 180 | + - Misleading phrasing |
| 181 | + - Actually: "OpenAI-compatible API" |
| 182 | + |
| 183 | +--- |
| 184 | + |
| 185 | +## New/Accurate Claims |
| 186 | + |
| 187 | +### Added/Updated |
| 188 | + |
| 189 | +1. ✅ "All processing stays on your device" |
| 190 | + - Directly from security docs |
| 191 | + |
| 192 | +2. ✅ "Works in air-gapped environments" |
| 193 | + - Documented in security reference |
| 194 | + |
| 195 | +3. ✅ "No telemetry or usage data collection" |
| 196 | + - Explicitly stated in security docs |
| 197 | + |
| 198 | +4. ✅ "OpenAI-compatible REST API" |
| 199 | + - Accurate description from README |
| 200 | + |
| 201 | +5. ✅ "Python and JavaScript SDKs" |
| 202 | + - Documented and available |
| 203 | + |
| 204 | +6. ✅ "Powered by ONNX Runtime" |
| 205 | + - Core technology accurately described |
| 206 | + |
| 207 | +7. ✅ "No Azure subscription required" |
| 208 | + - Key differentiator, accurately stated |
| 209 | + |
| 210 | +--- |
| 211 | + |
| 212 | +## Documentation Strategy |
| 213 | + |
| 214 | +### Before This Cleanup |
| 215 | + |
| 216 | +- Internal docs system built with mdsvex |
| 217 | +- Docs routes at `/docs` |
| 218 | +- Navigation linked to internal pages |
| 219 | +- Attempted to be comprehensive doc site |
| 220 | + |
| 221 | +### After This Cleanup |
| 222 | + |
| 223 | +- Main documentation → Microsoft Learn |
| 224 | +- Internal docs infrastructure **preserved but not linked** |
| 225 | +- Can be reactivated if needed |
| 226 | +- Focus website on product overview and model hub |
| 227 | + |
| 228 | +### Microsoft Learn URL |
| 229 | + |
| 230 | +`https://learn.microsoft.com/en-us/azure/ai-foundry/foundry-local/get-started` |
| 231 | + |
| 232 | +--- |
| 233 | + |
| 234 | +## Testing Results |
| 235 | + |
| 236 | +### Build Status |
| 237 | + |
| 238 | +✅ **Build Successful** |
| 239 | + |
| 240 | +```bash |
| 241 | +npm run build |
| 242 | +# Result: Success with minor warnings |
| 243 | +# - 1 warning about unused CSS selector (cosmetic) |
| 244 | +# - 1 warning about large chunks (performance consideration) |
| 245 | +# - All routes built successfully |
| 246 | +``` |
| 247 | + |
| 248 | +### Warnings (Non-Critical) |
| 249 | + |
| 250 | +1. **Unused CSS selector `.line-clamp-1`** in `models/+page.svelte` |
| 251 | + - Cosmetic issue, doesn't affect functionality |
| 252 | + |
| 253 | +2. **Large chunk warning** (622KB, 697KB chunks) |
| 254 | + - Performance consideration for future optimization |
| 255 | + - Not blocking |
| 256 | + |
| 257 | +3. **404 Warning** for `/docs/styling` |
| 258 | + - Expected, internal docs not fully populated |
| 259 | + - Not user-facing |
| 260 | + |
| 261 | +--- |
| 262 | + |
| 263 | +## Alignment with Actual Docs |
| 264 | + |
| 265 | +### What Foundry Local Actually Does (from `/docs`) |
| 266 | + |
| 267 | +✅ Runs LLMs locally on your device |
| 268 | +✅ Uses ONNX Runtime for optimization |
| 269 | +✅ Supports hardware acceleration (GPU, NPU) |
| 270 | +✅ Provides OpenAI-compatible API |
| 271 | +✅ Offers Python and JavaScript SDKs |
| 272 | +✅ Works in air-gapped environments |
| 273 | +✅ No telemetry collection |
| 274 | +✅ No Azure subscription required |
| 275 | +✅ Free to use (using your own hardware) |
| 276 | + |
| 277 | +### What Was Being Claimed (Before Cleanup) |
| 278 | + |
| 279 | +❌ HIPAA/GDPR/PCI compliance |
| 280 | +❌ Audit logging and monitoring |
| 281 | +❌ One-click Azure deployment |
| 282 | +❌ Azure AI REST API endpoints |
| 283 | +❌ Seamless cloud transitions |
| 284 | + |
| 285 | +--- |
| 286 | + |
| 287 | +## Recommendations for Future |
| 288 | + |
| 289 | +### Short Term |
| 290 | + |
| 291 | +1. Monitor Microsoft Learn docs for updates |
| 292 | +2. Keep internal docs infrastructure maintained |
| 293 | +3. Consider syncing `/docs` markdown with website content |
| 294 | +4. Update version numbers as releases happen |
| 295 | + |
| 296 | +### Long Term |
| 297 | + |
| 298 | +1. **Consider Dual Documentation Strategy:** |
| 299 | + - Microsoft Learn: User-facing guides, getting started |
| 300 | + - Internal Docs: API reference, advanced topics, developer content |
| 301 | +2. **Add More Accurate Content:** |
| 302 | + - Performance benchmarks |
| 303 | + - Model comparison tables |
| 304 | + - Hardware requirements detail |
| 305 | + - Actual use cases from users |
| 306 | + |
| 307 | +3. **Improve Model Hub:** |
| 308 | + - Already exists at `/models` |
| 309 | + - Could expand with more details |
| 310 | + - Filter by hardware compatibility |
| 311 | + |
| 312 | +--- |
| 313 | + |
| 314 | +## Questions or Issues? |
| 315 | + |
| 316 | +If you need to: |
| 317 | + |
| 318 | +- **Reactivate internal docs:** See `/DOCS_INFRASTRUCTURE_README.md` |
| 319 | +- **Update marketing claims:** Verify against `/docs` first |
| 320 | +- **Add new features:** Update both website and Microsoft Learn |
| 321 | +- **Report issues:** Use GitHub issues |
| 322 | + |
| 323 | +--- |
| 324 | + |
| 325 | +## Summary |
| 326 | + |
| 327 | +This cleanup ensures the Foundry Local website: |
| 328 | + |
| 329 | +- ✅ Makes only claims supported by documentation |
| 330 | +- ✅ Links to official Microsoft Learn documentation |
| 331 | +- ✅ Focuses on actual product capabilities |
| 332 | +- ✅ Preserves infrastructure for future use |
| 333 | +- ✅ Builds successfully without errors |
| 334 | +- ✅ Maintains professional, accurate messaging |
| 335 | + |
| 336 | +**No functionality was removed**, only marketing claims corrected and links updated. |
0 commit comments