Skip to content

Improve Go documentation usability #1395

Closed
@greyscaled

Description

@greyscaled

Overview

This ticket originally grew out of a question: should we build a version of https://apidocs.coder.com/ for our /coder/coder v2 codebase?

We decided that Godoc gives us the benefits of Swagger and more, with more reliability. This is because there are less manual/duplicative pieces; the Godoc is autogenerated from the Go code (whereas Swagger is manual Go comments/annotations).

Acceptance Criteria

We have a Godoc of our API/SDK (self-hosted until the repository is public, after which it can be freely hosted)

See breakout session comment here: #1395 (comment)


Metadata

Metadata

Assignees

Labels

apiArea: HTTP APIdocsArea: coder.com/docs

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions