Problem
No troubleshooting guide for common issues:
- Users stuck on installation problems
- Repetitive support questions
- No self-service debugging
- GitHub issues filled with duplicates
Solution
Create /troubleshooting page with common issues + solutions:
Categories
1. Installation Issues
Extension not appearing in VS Code
- Clear VS Code extension cache
- Restart VS Code
- Check VS Code version (minimum required)
- Manual installation from VSIX
Syntax highlighting not working
- File extension not recognized (.st, .iec)
- Language mode not set correctly
- Conflicting extensions
- Reload window
2. Compatibility Issues
Not working with TwinCAT
- File encoding (UTF-8 required)
- Line ending conflicts (CRLF vs LF)
- TwinCAT-specific pragma syntax
Not working with Codesys
- Codesys dialect differences
- Import paths
- Library references
3. Performance Issues
Extension slowing down VS Code
- Large file handling
- Disable unused features
- Increase memory limit
- Split large programs
Syntax highlighting lagging
- File too large (>10,000 lines)
- Nested structures depth
- Regex performance
4. Feature-Specific Issues
Autocomplete not working
- IntelliSense settings
- Workspace trust settings
- Language server not starting
Go to definition not working
- Workspace indexing incomplete
- Relative paths
- Cross-file references
Page Structure
<h1>Troubleshooting</h1>
{#each categories as category}
<section>
<h2>{category.name}</h2>
{#each category.issues as issue}
<details class="issue">
<summary>
<h3>{issue.problem}</h3>
</summary>
<div class="solution">
<h4>Solution:</h4>
{@html issue.solution}
{#if issue.relatedLinks}
<h4>Related:</h4>
<ul>
{#each issue.relatedLinks as link}
<li><a href={link.url}>{link.text}</a></li>
{/each}
</ul>
{/if}
</div>
</details>
{/each}
</section>
{/each}
<section class="contact">
<h2>Still Having Issues?</h2>
<p>
<a href="https://github.com/ControlForge-Systems/issues">
Report an issue on GitHub
</a>
</p>
</section>
Search Integration
- Searchable by issue symptoms
- Tags: installation, performance, compatibility
- Link from error messages (if possible)
Success Criteria
- 20+ common issues documented
- Clear step-by-step solutions
- Screenshots/videos for complex issues
- Linked from footer + docs
- Searchable
- Regularly updated with new issues
Problem
No troubleshooting guide for common issues:
Solution
Create
/troubleshootingpage with common issues + solutions:Categories
1. Installation Issues
Extension not appearing in VS Code
Syntax highlighting not working
2. Compatibility Issues
Not working with TwinCAT
Not working with Codesys
3. Performance Issues
Extension slowing down VS Code
Syntax highlighting lagging
4. Feature-Specific Issues
Autocomplete not working
Go to definition not working
Page Structure
Search Integration
Success Criteria