nlweb-ai/nlweb-net

🚀 Docs: Add Quickstart to README

Ouverte

#82 ouverte le 18 août 2025

Voir sur GitHub
 (0 commentaire) (0 réaction) (0 personne assignée)C# (8 forks)auto 404
docsgood first issue

Métriques du dépôt

Stars
 (23 étoiles)
MĂ©triques de merge PR
 (Métriques PR en attente)

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

Guide contributeur

Direction de recherche
Ajoutez une section Quickstart au README avec l'installation via NuGet, l'exécution de la démo localement avec dotnet run et via Docker, et incluez des conseils de configuration minimaux. Liez aux fichiers de documentation existants doc/demo setup guide.md et doc/multi backend configuration.md.
Stack technique
csharp
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
RĂ©cente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
C#Docker
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
95