oxidecomputer / oxidecomputer/oxide.go

Improve documentation and getting started guide

Open
#148 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Go SDK Task
Dominant language
Go
Stars
26
Forks
6
Avg merge
5h 33m
Merged PRs (30d)
9

Description

Update the following content.

Use your judgement on how it should be improved.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read README.md and the Go SDK section at https://docs.oxide.computer/api/guides/sdks#_go to identify outdated or missing getting-started information. Improve both referenced locations consistently, using the existing content and your judgement as the completion criteria.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.