Skip to content

Commit 9499318

Browse files
BornToBeRootBornToBeRoot
committed
Chore: Adjust agents md
1 parent 91515c5 commit 9499318

File tree

1 file changed

+41
-40
lines changed

1 file changed

+41
-40
lines changed

‎agents.md‎

Lines changed: 41 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
## Repository Overview
44

5-
**NETworkManager** is a comprehensive, enterprise-ready network management and troubleshooting application built with C# and WPF. It provides a unified interface for network administrators and IT professionals to manage, monitor, and troubleshoot network infrastructure using tools like Remote Desktop, SSH, PowerShell, VNC, network scanners, and diagnostic utilities.
5+
**NETworkManager** is a comprehensive, enterprise-ready network management and troubleshooting application built with C# and WPF. It provides a unified interface for network administrators and IT professionals to manage, monitor, and troubleshoot network infrastructure using tools like Remote Desktop, PuTTY (SSH, Telnet, Serial, etc.), PowerShell (k9s, WSL, etc.), TigerVNC, network scanners (IP scanner, Port scanner, WiFi Analyzer), and diagnostic utilities (Ping monitor, traceroute, etc.).
66

77
- **Repository**: https://github.com/BornToBeRoot/NETworkManager
88
- **License**: GNU General Public License v3
99
- **Primary Language**: C# (.NET 10)
10-
- **UI Framework**: WPF (Windows Presentation Foundation) with MahApps.Metro
11-
- **Documentation**: Docusaurus-based website
10+
- **UI Framework**: WPF (Windows Presentation Foundation) with `MahApps.Metro`
11+
- **Documentation**: Docusaurus-based website and documentation at https://borntoberoot.net/NETworkManager
1212
- **Platform**: Windows (x64)
1313

1414
## Project Structure
@@ -18,33 +18,34 @@
1818
The repository is organized into multiple C# projects following a modular architecture:
1919

2020
```
21-
/home/runner/work/NETworkManager/NETworkManager/
21+
REPOSITORY_ROOT/
2222
├── Source/ # Main source code directory
23-
│ ├── NETworkManager/ # Main WPF application (Views, ViewModels, Controls)
24-
│ ├── NETworkManager.Models/ # Business logic and data models
25-
│ ├── NETworkManager.Utilities/ # Helper classes and utilities
23+
│ ├── NETworkManager/ # Main WPF application (Views, ViewModels, Controls)
24+
│ ├── NETworkManager.Models/ # Business logic and data models
25+
│ ├── NETworkManager.Utilities/ # Helper classes and utilities
2626
│ ├── NETworkManager.Utilities.WPF/ # WPF-specific utilities
27-
│ ├── NETworkManager.Converters/ # WPF value converters
28-
│ ├── NETworkManager.Validators/ # Input validation logic
29-
│ ├── NETworkManager.Controls/ # Custom WPF controls
30-
│ ├── NETworkManager.Localization/ # Internationalization resources
31-
│ ├── NETworkManager.Settings/ # Application settings management
32-
│ ├── NETworkManager.Profiles/ # Profile management
33-
│ ├── NETworkManager.Update/ # Update checking functionality
27+
│ ├── NETworkManager.Converters/ # WPF value converters
28+
│ ├── NETworkManager.Validators/ # Input validation logic
29+
│ ├── NETworkManager.Controls/ # Custom WPF controls
30+
│ ├── NETworkManager.Localization/ # Internationalization resources
31+
│ ├── NETworkManager.Settings/ # Application settings management
32+
│ ├── NETworkManager.Profiles/ # Profile management
33+
│ ├── NETworkManager.Update/ # Update functionality
3434
│ ├── NETworkManager.Documentation/ # Documentation resources
35-
│ ├── NETworkManager.Setup/ # WiX installer project
36-
│ └── 3rdparty/ # Third-party dependencies (e.g., Dragablz)
37-
├── Website/ # Docusaurus documentation website
38-
├── Scripts/ # Build and automation scripts
39-
├── Chocolatey/ # Chocolatey package definition
40-
├── WinGet/ # WinGet package manifest
41-
└── Images/ # Application icons and images
35+
│ ├── NETworkManager.Setup/ # WiX installer project
36+
│ └── 3rdparty/ # Third-party dependencies (e.g., Dragablz)
37+
│ └── (managed-manually) # NOTE: Maintained manually — AI agents MUST NOT modify this directory
38+
├── Website/ # Docusaurus documentation website
39+
├── Scripts/ # Build and automation scripts
40+
├── Chocolatey/ # Chocolatey package definition
41+
├── WinGet/ # WinGet package manifest
42+
└── Images/ # Application icons and images
4243
```
4344

4445
### Key Statistics
4546

46-
- **~645 C# source files** across multiple projects
47-
- **~149 XAML files** for UI definitions
47+
- **650+ C# source files** across multiple projects
48+
- **150+ XAML files** for UI definitions
4849
- **12 distinct project modules** in the solution
4950
- **64+ documentation pages** in Docusaurus format
5051
- **16+ supported languages** for localization
@@ -60,7 +61,7 @@ The repository is organized into multiple C# projects following a modular archit
6061
- **Target**: Windows 10.0.22621.0 (Windows 11)
6162

6263
**UI Framework & Design**:
63-
- **MahApps.Metro 2.4.11** - Modern UI toolkit providing Metro-style controls and themes
64+
- **MahApps.Metro** - Modern UI toolkit providing Metro-style controls and themes
6465
- **MahApps.Metro.IconPacks** - Icon libraries (FontAwesome, Material, Modern, Octicons)
6566
- **MahApps.Metro.SimpleChildWindow** - Dialog windows
6667
- **Dragablz** - Tearable/draggable tab control
@@ -89,26 +90,26 @@ The repository is organized into multiple C# projects following a modular archit
8990
### Website (Docusaurus)
9091

9192
**Documentation Stack**:
92-
- **Docusaurus 3.9.2** - Static site generator
93-
- **React 19.2.1** - UI framework
93+
- **Docusaurus** - Static site generator
94+
- **React** - UI framework
9495
- **@mdx-js/react** - MDX support
9596
- **react-image-gallery** - Image galleries
9697
- **Prism** - Code syntax highlighting
9798

9899
**Website Structure**:
99100
```
100101
Website/
101-
├── docs/ # Documentation pages
102+
├── docs/ # Documentation pages
102103
│ ├── application/ # Feature documentation
103104
│ ├── changelog/ # Version history
104-
│ ├── faq/ # Frequently asked questions
105-
│ └── settings/ # Settings documentation
105+
│ ├── faq/ # Frequently asked questions
106+
│ └── settings/ # Settings documentation
106107
├── blog/ # Blog posts
107108
├── src/ # React components and pages
108109
├── static/ # Static assets (images, files)
109-
├── docusaurus.config.js # Site configuration
110-
├── sidebars.js # Documentation sidebar structure
111-
└── package.json # npm dependencies
110+
├── docusaurus.config.js # Site configuration
111+
├── sidebars.js # Documentation sidebar structure
112+
└── package.json # npm dependencies
112113
```
113114

114115
## Development Setup
@@ -149,7 +150,7 @@ dotnet build .\Source\NETworkManager.sln --configuration Release --no-restore
149150

150151
```bash
151152
cd Website
152-
npm install # Install dependencies
153+
npm install # Install dependencies
153154
npm start # Start development server
154155
npm run build # Build for production
155156
```
@@ -179,8 +180,8 @@ The website is deployed to GitHub Pages at: https://borntoberoot.net/NETworkMana
179180

180181
2. **Remote Access** (`Source/NETworkManager/Controls/`):
181182
- Remote Desktop (RDP) integration
182-
- PuTTY (SSH, Serial) integration
183-
- PowerShell and VNC controls
183+
- PuTTY (SSH, Telnet, Serial) integration
184+
- PowerShell and TigerVNC (VNC) controls
184185

185186
3. **UI/UX** (`Source/NETworkManager/Views/` and `.xaml` files):
186187
- WPF views following MVVM pattern
@@ -259,7 +260,7 @@ The website is deployed to GitHub Pages at: https://borntoberoot.net/NETworkMana
259260

260261
**Package Formats**:
261262
- **Setup (MSI)**: WiX installer in `Source/NETworkManager.Setup/`
262-
- **Portable**: Xcopy deployment
263+
- **Portable**: ZIP file
263264
- **Archive**: ZIP file
264265

265266
## Security Considerations
@@ -407,10 +408,10 @@ git diff
407408

408409
### Embedded Tools Integration
409410

410-
- **Remote Desktop**: Native RDP using WPF control
411-
- **PuTTY**: Process integration with custom window hosting
412-
- **PowerShell**: Windows Terminal/PowerShell embedding
413-
- **VNC**: TigerVNC integration
411+
- **Remote Desktop**: Native RDP using `AxMSTSCLib`, `AxMsRdpClient10NotSafeForScripting` and `WindowsFormsHost`
412+
- **PuTTY**: PuTTY window embedding / process hosting with `WindowsFormsHost`
413+
- **PowerShell**: PowerShell window embedding / process hosting with `WindowsFormsHost`
414+
- **VNC**: TigerVNC window embedding / process hosting with `WindowsFormsHost`
414415

415416
## Tips for AI Agents
416417

0 commit comments

Comments
 (0)