nlweb-ai/nlweb-net

🚀 Docs: Add Quickstart to README

Offen

#82 geöffnet am 18.08.2025

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)C# (8 Forks)auto 404
docsgood first issue

Repository-Metriken

Stars
 (23 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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-Richtung
Füge einen Quickstart Abschnitt zur README hinzu mit Installation über NuGet, Ausführen der Demo lokal mit dotnet run und über Docker, sowie minimale Konfigurationshinweise. Verlinke zu den vorhandenen Dokumentationsdateien doc/demo setup guide.md und doc/multi backend configuration.md.
Tech Stack
csharp
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
C#Docker
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
95