milvus-io/milvus-sdk-go

[Document] Elaborate Golang API reference

Open

#191 opened on Sep 2, 2021

View on GitHubContributor guide
 (4 comments) (0 reactions) (1 assignee)Go (113 forks)auto 404
HACKTOBERFESTgood first issuekind/documentation

Repository metrics

Stars
 (367 stars)
PR merge metrics
 (PR metrics pending)

Description

Is there anything that's missing or inappropriate in the docs? Please describe.

Content in Go API reference is insufficient. Clarification on collection schema in create_collection.md is particularly needed.

Describe your suggestion

Please submit a pull request and supplement the content. Contribution to any of the API reference documents under https://github.com/milvus-io/milvus-sdk-go/blob/master/docs/ is welcomed.

Suggested Step

Please find all API reference doc at https://github.com/milvus-io/milvus-sdk-go/tree/master/docs and the code at https://github.com/milvus-io/milvus-sdk-go/tree/master/client.

You will need to add content according to the code.

Should you need any assistance, please feel free to contact us.

Contributor guide

Research direction
Review the existing doc files under docs/ directory and the corresponding client code to supplement missing content, especially for create collection.md.
Tech stack
go
Domain
backendapidocumentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitGo
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70