Skip to content

Commit e81e817

Browse files
committed
docs: Update README.md to enhance repository structure and add development guidelines
1 parent 3ca9771 commit e81e817

File tree

1 file changed

+22
-6
lines changed

1 file changed

+22
-6
lines changed

README.md

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,10 @@ This implementation follows the [official NLWeb specification](https://github.co
4242

4343
```text
4444
NLWebNet/
45+
├── .github/ # 🔧 GitHub workflows, dependabot, and automation
46+
│ ├── workflows/ # CI/CD pipeline definitions
47+
│ ├── dependabot.yml # Dependency update automation
48+
│ └── custom-instructions.md # Development guidelines
4549
├── src/NLWebNet/ # 📦 Core library (published NuGet package)
4650
│ ├── Models/ # Request/response data models
4751
│ ├── Services/ # Business logic interfaces and implementations
@@ -51,17 +55,29 @@ NLWebNet/
5155
│ └── Middleware/ # Request processing middleware
5256
├── samples/ # 🎯 Sample applications and usage examples
5357
│ ├── Demo/ # 🎮 .NET 9 Blazor Web App demo application
58+
│ ├── AspireDemo/ # 🏗️ .NET Aspire sample application
5459
│ └── AspireHost/ # 🏗️ .NET Aspire orchestration host
55-
├── doc/ # � Documentation and setup guides
60+
├── deployment/ # 🚀 Deployment configurations and scripts
61+
│ ├── azure/ # Azure-specific deployment templates
62+
│ ├── docker/ # Docker and container configurations
63+
│ ├── kubernetes/ # Kubernetes manifests and Helm charts
64+
│ └── scripts/ # Deployment automation scripts
65+
├── doc/ # 📚 Documentation and setup guides
5666
│ ├── demo-setup-guide.md # 🔧 Complete AI integration setup guide
5767
│ ├── manual-testing-guide.md # 🧪 API testing instructions
5868
│ └── todo.md # 📋 Implementation status and roadmap
5969
├── tests/ # 🧪 Unit and integration tests
60-
│ └── NLWebNet.Tests/ # 📋 MSTest test project (39 tests)
61-
├── helm/ # ⚙️ Helm charts for Kubernetes
62-
├── k8s/ # ⚙️ Kubernetes manifests
63-
├── deploy/ # 🚀 Azure deployment templates
64-
└── scripts/ # �️ Build and deployment scripts
70+
│ └── NLWebNet.Tests/ # 📋 MSTest test project (264 tests)
71+
├── scripts/ # 🛠️ Build and utility scripts
72+
│ └── markdown-tools/ # Markdown linting and formatting tools
73+
├── .dockerignore # Docker ignore patterns
74+
├── .gitignore # Git ignore patterns
75+
├── .markdownlint.json # Markdown linting configuration
76+
├── CHANGELOG.md # Version history and release notes
77+
├── LICENSE # MIT license
78+
├── NLWebNet.sln # Visual Studio solution file
79+
├── NuGet.Config # NuGet package source configuration
80+
└── README.md # This file
6581
6682
```
6783

0 commit comments

Comments
 (0)