You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+49-5Lines changed: 49 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,30 @@
1
1
# NLWebNet
2
2
3
3
[](https://github.com/jongalloway/NLWebNet/actions/workflows/build.yml)
A .NET implementation of the [NLWeb protocol](https://github.com/microsoft/NLWeb) for building natural language web interfaces. This project provides both a reusable library and a demo application showcasing the NLWeb standard.
11
11
12
+
> **⚠️ PROOF OF CONCEPT - NOT PRODUCTION READY**
13
+
>
14
+
> This is an experimental implementation created for **testing and evaluation purposes only**. While functional, this library is not intended for production use and should be considered a proof of concept to demonstrate NLWeb protocol capabilities in .NET environments.
15
+
>
16
+
> **Use cases:**
17
+
> - 🧪 Protocol evaluation and experimentation
18
+
> - 📚 Learning and understanding NLWeb concepts
19
+
> - 🔬 Research and development prototyping
20
+
> - 🎯 Testing integration patterns with AI services
21
+
>
22
+
> **Not recommended for:**
23
+
> - ❌ Production applications
24
+
> - ❌ Critical business systems
25
+
> - ❌ Public-facing services
26
+
> - ❌ Applications requiring enterprise support
27
+
12
28
## 📋 Overview
13
29
14
30
NLWeb is a protocol for creating conversational interfaces to web content and data. It enables natural language querying with three main modes:
@@ -147,6 +163,8 @@ graph TB
147
163
148
164
## 🚀 Quick Start
149
165
166
+
> **📋 Note**: This library is provided for **testing and evaluation purposes only**. Please review the development status above before integrating into any project.
167
+
150
168
### Using the Library in Your Project
151
169
152
170
1. Add the NLWebNet library to your ASP.NET Core project:
This is a **fully functional implementation** of the NLWeb protocol, ready for production use as a prerelease package.
404
+
This is a **proof of concept implementation** of the NLWeb protocol, available as an **alpha prerelease package** for testing and evaluation purposes only.
379
405
380
-
**✅ Completed (Phases 1-10.5):**
406
+
### ⚠️ EXPERIMENTAL SOFTWARE - NOT PRODUCTION READY
407
+
408
+
**✅ Completed (Phases 1-11) - For Testing & Evaluation:**
381
409
382
410
-[x]**Core Library**: Complete NLWeb protocol implementation with Minimal API endpoints
383
411
-[x]**Data Models**: Request/response models with validation and JSON serialization
384
412
-[x]**Business Logic**: Service layer with Microsoft.Extensions.AI integration
413
+
-[x]**NuGet Package**: Published as alpha prerelease at [nuget.org/packages/NLWebNet](https://www.nuget.org/packages/NLWebNet/)
414
+
-[x]**CI/CD Pipeline**: Automated build, test, validation, and publishing to NuGet.org
415
+
-[x]**Documentation**: Comprehensive README, API documentation, and usage examples
416
+
417
+
**🎯 Intended Use Cases:**
418
+
419
+
- Protocol evaluation and experimentation
420
+
- Learning NLWeb concepts and implementation patterns
421
+
- Research and development prototyping
422
+
- Testing integration with AI services and data backends
423
+
424
+
**❌ Not Suitable For:**
425
+
426
+
- Production applications or critical business systems
427
+
- Public-facing services or enterprise applications
428
+
- Applications requiring commercial support or SLAs
385
429
-[x]**MCP Integration**: Full Model Context Protocol support with tools and prompts
386
430
-[x]**Demo Application**: Modern .NET 9 Blazor Web App with interactive components
387
431
-[x]**Testing**: 39 unit tests with 100% pass rate plus comprehensive manual testing guides
Copy file name to clipboardExpand all lines: doc/todo.md
+39-12Lines changed: 39 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -68,9 +68,11 @@ The NLWebNet library is now fully functional and feature complete with a modern
68
68
69
69
**Phases 1-10.5 are now complete.** The library provides a complete implementation of the NLWeb protocol with both traditional controller-based endpoints (legacy) and modern minimal API endpoints for improved performance and maintainability. The project includes comprehensive configuration management, CORS support, and extensive testing infrastructure with manual testing resources.
70
70
71
-
**✅ MAJOR BREAKTHROUGH: NuGet Package API Issue RESOLVED** - The NLWebNet package is now fully functional with working extension methods accessible via `using NLWebNet;`. End-to-end testing confirms that consumer applications can successfully install the package, use the `AddNLWebNet()` and `MapNLWebNet()` extension methods, and run working HTTP servers.
71
+
**✅ MAJOR BREAKTHROUGH: NuGet Package PUBLISHED SUCCESSFULLY** - The NLWebNet package is now live on NuGet.org at https://www.nuget.org/packages/NLWebNet/! The package is fully functional with working extension methods accessible via `using NLWebNet;`. End-to-end testing confirms that consumer applications can successfully install the package, use the `AddNLWebNet()` and `MapNLWebNet()` extension methods, and run working HTTP servers.
72
72
73
-
**The project is ready for Phase 11 (Deployment & Production Readiness) and NuGet.org publication** with a fully functional demonstration application running at `http://localhost:5037`, a working NuGet package with confirmed extension method accessibility, and comprehensive configuration and testing infrastructure.
73
+
**🚀 PRODUCTION MILESTONE ACHIEVED: NuGet.org Publication Complete** - Version 0.1.0-alpha.2 successfully published with automated CI/CD pipeline including build, test, validation, and publication. The package includes symbols (.snupkg), comprehensive metadata, and all required dependencies.
74
+
75
+
**The project has successfully completed Phase 11 (Deployment & Production Readiness) and NuGet.org publication** with a fully functional demonstration application running at `http://localhost:5037`, a published NuGet package available at [nuget.org/packages/NLWebNet](https://www.nuget.org/packages/NLWebNet/), confirmed extension method accessibility, and comprehensive configuration and testing infrastructure.
74
76
75
77
## Implementation Plan
76
78
@@ -396,7 +398,7 @@ Comprehensive testing and validation infrastructure has been implemented coverin
396
398
397
399
### Phase 10: Documentation & Packaging ✅
398
400
399
-
#### Status: Substantially Complete (API issue identified for future resolution)
401
+
#### Status: **COMPLETED SUCCESSFULLY - PUBLISHED TO NUGET.ORG**
400
402
401
403
-[x] Library documentation:
402
404
-[x] XML documentation comments for public APIs and endpoints
@@ -414,7 +416,15 @@ Comprehensive testing and validation infrastructure has been implemented coverin
414
416
-[x] ✅ **RESOLVED**: API surface area issue - Extensions accessible via `using NLWebNet;`
415
417
-[x] ✅ **COMPLETED**: Package API exposure working correctly
416
418
-[x] ✅ **SUCCESS**: Complete local package installation testing with working extension methods
417
-
-[ ] Publish to NuGet.org (ready for publication)
419
+
-[x] ✅ **PUBLISHED**: Package successfully published to [NuGet.org](https://www.nuget.org/packages/NLWebNet/)
420
+
421
+
#### **🎉 PUBLICATION SUCCESS:**
422
+
423
+
- ✅ **Package Published**: Version 0.1.0-alpha.2 successfully published to NuGet.org
0 commit comments