nlweb-ai/nlweb-net

🚀 Docs: Add Quickstart to README

Aperta

#82 aperta il 18 ago 2025

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)C# (8 fork)auto 404
docsgood first issue

Metriche repository

Star
 (23 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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

Guida contributor

Direzione di ricerca
Aggiungi una sezione Quickstart al README con installazione tramite NuGet, esecuzione della demo localmente con dotnet run e tramite Docker, e includi suggerimenti di configurazione minimi. Collega ai file di documentazione esistenti doc/demo setup guide.md e doc/multi backend configuration.md.
Tech stack
csharp
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
C#Docker
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
95