Bei der Veröffentlichung eines Pakets über Nuget, speziell ein SDK - Was ist die beste Vorgehensweise bei der Veröffentlichung der Dokumentation (api Referenz zum Beispiel)? - Gibt es einen bestimmten Ort, um Dokumentation in den Veröffentlichungsprozess hochzuladen oder sollte es nur in Git sein?Nuget - Wo veröffentliche ich Dokumentation?
Für kurze API-Referenz ist die gängige Praxis XML documentation Datei [s] in einem NuGet-Paket.
Für eine vollwertige Dokumentation ist der beste Ort außerhalb von NuGet. Für mein SDK lade ich CHM hoch, um die Seite auf GitHub zu veröffentlichen. Technisch gesehen können Sie alles, was Sie wollen, in das Paket aufnehmen, aber nur sehr wenige Benutzer werden die Dokumentation dort entdecken und für die Mehrheit der Benutzer wird es nur die Paketgröße für keinen Wert aufblähen.
Sie müssen eine XML-Datei enthalten - You can see here
Bevor Sie ein NuGet Paket erstellen können, Sie etwas zu verpacken müssen. Zumindest benötigen Sie eine kompilierte Assembly (.dll), auf die Benutzer verweisen können. Sie sollten jedoch auch eine Dokumentationsdatei (.xml) einfügen. Sie dürfen NuGet-Pakete erstellen, die keine Dokumentationsdatei enthalten, aber den Benutzern werden nicht die vielen hilfreichen Methoden-/Klassen-/Parameterkommentare angezeigt, die Sie verantwortungsvoll in Ihren Code aufgenommen haben.
github Seiten ????? – Shyju
Sie können alle Ansätze verwenden, z. B. das Einrichten einer Website ähnlich wie http://docs.microsoft.com. NuGet selbst gibt Ihnen keinen Weg dazu. –