JanusGraph / JanusGraph/janusgraph-dotnet

Publish API docs

Open
#15 0 comments 0 reactions 0 assignees View on GitHub
area/docs
Dominant language
C#
Stars
26
Forks
5
PR merge metrics
No merged PRs in 30d

Description

We should create and publish API docs for the library. The most widely used tool for that seems to be [DocFX](https://dotnet.github.io/docfx/). That only has the downside right now that it still requires Mono (although they are working on also supporting .NET Core).

Contributor guide

No contributing guide indexed for this repository

Research direction

No files or tests are identified in the issue. Start by reviewing the library's public API and DocFX's documentation, including its Mono requirement; done means the API documentation is generated and published for the library.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.