Add Welcome

kuro 2026-10-15 20:30:47 +00:00
parent 822be26029
commit 4ea8cdbd37
1 changed files with 34 additions and 0 deletions

34
Welcome.md Normal file

@ -0,0 +1,34 @@
# 🏡 Welcome to the "BMC TPL Code All around" Wiki
Welcome to the official wiki of the **BMC TPL Code All around** extension for Visual Studio Code.
This project aims to bring the writing of BMC Helix Discovery TPL (Template Language) scripts out of the era of simple text editors and transform VS Code into a **fully-fledged, intelligent Integrated Development Environment (IDE)**.
This wiki serves as a central hub for users who want to get the most out of the extension, as well as documentation for the ongoing development and architecture of the code.
---
## 📚 Table of Contents
Navigate through the following sections to learn more about installation, features, and our future plans:
### 🚀 For Users
- **[Installation & Getting Started](Installation-EN)** – How to install and activate the plugin in VS Code.
- **[Features & Usage](Features-EN)** – Detailed explanations of the linter, auto-formatter, IntelliSense, and hover documentation.
- **[Snippets & Quick Fixes](Snippets-Quick-Fixes-EN)** – An overview of all smart templates (like `tpl_skeleton`, control structures) and automatic error resolutions.
- **[Configuration](Configuration-EN)** – How to adapt the plugin to your needs via the VS Code settings (e.g., default author, target TPL version).
### 🛠️ For Developers & Architecture
- **[Architecture & Structure](Architecture-EN)** – *(Planned)* Insights into the modular structure of the code (Linter, Providers, Utils).
- **[Future of the Project (Roadmap)](Roadmap-EN)** – Our current checklist and roadmap for upcoming refactorings, deep code analysis, and smart context features.
- **[Local Development](Local-Development-EN)** – How to build, test, and compile the project locally.
---
## 💡 About the Project
**TPL Code All around** saves you from tedious typing, formats your code according to strict best practices, prevents syntax errors even before deployment, and understands cross-project dependencies.
Whether you are building deep `syncmapping` structures, creating complex regex queries, or simply wanting to deliver clean, well-documented code – this extension acts as your virtual "pair programming" partner.
---