Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document the Library #2

Closed
FlorianHockmann opened this issue Oct 5, 2018 · 1 comment · Fixed by #14
Closed

Document the Library #2

FlorianHockmann opened this issue Oct 5, 2018 · 1 comment · Fixed by #14
Labels
area/docs

Comments

@FlorianHockmann
Copy link
Member

The documentation should explain the relation between JanusGraph.Net and Gremlin.Net and show some usage examples. It also needs to list already implemented capabilities and mention features that are still missing.
Automatically generated API docs would also be a good addition, but could also be done with a separate issue.
DocFX is probably the best tool to create docs for a .NET library, especially for the API docs.
@FlorianHockmann FlorianHockmann mentioned this issue Oct 5, 2018
Merged
@FlorianHockmann FlorianHockmann mentioned this issue Apr 6, 2019
Merged
@FlorianHockmann
Copy link
Member Author

I created #15 as a separate issue for the API docs as that is more complicated and not really necessary for the first version.

FlorianHockmann added a commit that referenced this issue Apr 14, 2019
@FlorianHockmann
Add usage docs #2
cf8cbd4 
This duplicates some of the content from the new .NET chapter in
JanusGraph's docs as that isn't published yet.
We can later clean up this duplication, especially when we have a more
flexible way to generate the docs (e.g., with MkDocs).

Signed-off-by: Florian Hockmann <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area/docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add usage docs FlorianHockmann/janusgraph-dotnet
1 participant
@FlorianHockmann