search

octokit / octokit.net

A GitHub API client library for .NET
https://octokitnet.readthedocs.io/en/latest/
MIT License
2.65k stars 1.07k forks source link

[DOCS]: Full class documentation #2699

Open gbakeman opened 1 year ago

gbakeman commented 1 year ago

Introduction

It would be great to have a full API/class documentation library available as a developer who'd like to use this library. I'm thinking it would look similar to the Microsoft Learn library. So the structure would begin with an introduction to the object in view, followed by any remarks and examples. Children would also be listed (Properties, Methods, Events, etc.)

Solutions

Integrate DocFX generation with ReadTheDocs site

DocFX is an open source technical documentation site generator by the dotnet organization. This may be the most straightforward and easiest solution. Integration with the existing ReadTheDocs site may be able to be done with this template, although I don't have any experience with these techs..

kfcampbell commented 1 year ago

For future reference, our current documentation lives here and indeed does not include the features mentioned above.

NeuroXiq commented 8 months ago

Hi! I'm working on software that will help with this :) Octokit.net API docs can be found here: https://dndocs.com/d/octokit2/api/Octokit.html Also I mentioned about DNDocs in issue on this repository: https://github.com/octokit/octokit.net/issues/2781 :)

Regards NeuroXiq

gbakeman commented 4 months ago

Hi all,

I'm working with Octokit again and wanted to come back to this issue. I've just updated the OP with a suggestion to use a ReadTheDocs template with our existing site, in order to integrate DocFX automatic generation with GitHub Actions. Besides GH Actions, I have very little experience with the other tech so I don't think I'll be able to help immediately with that if this solution sounds interesting.