nlweb-ai/nlweb-net

馃殌 Docs: Add Quickstart to README

Open

#82 opened on Aug 18, 2025

View on GitHub
聽(0 comments)聽(0 reactions)聽(0 assignees)C#聽(8 forks)auto 404
docsgood first issue

Repository metrics

Stars
聽(23 stars)
PR merge metrics
聽(PR metrics pending)

Description

A newcomer-friendly Quickstart to run NLWebNet in <10 minutes.

Scope

  • Add a Quickstart section to the root README.md with:
    • Install package via NuGet (library)
    • Run the demo sample (dotnet run) and via Docker
    • Minimal config hints
  • Link to doc/demo-setup-guide.md and doc/multi-backend-configuration.md for details

Acceptance Criteria

  • A new user can:
    • Install the package
    • Run the demo locally and via Docker
    • Find links to deeper docs

Labels: docs, good first issue

Contributor guide

Research direction
Add a Quickstart section to the README with installation via NuGet, running the demo locally with dotnet run and via Docker, and include minimal configuration hints. Link to the existing documentation files doc/demo setup guide.md and doc/multi backend configuration.md.
Tech stack
csharp
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C#Docker
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
95