Skip to content

Commit 07636c1

Browse files
lucasamonrcJoshua Coffey
andauthored
docs: go Getting Started & Selective Disclosure Attribution documentation are wrong (#1301)
Co-authored-by: Joshua Coffey <[email protected]>
1 parent 7599bf4 commit 07636c1

File tree

2 files changed

+14
-11
lines changed

2 files changed

+14
-11
lines changed

docs/go/index.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,21 @@ The Trinsic Go SDK makes it easy to interact with the Trinsic API from any Go ap
88
99
You have to go to the [other downloads](https://go.dev/dl/) page to get the `arm64` version for sure.
1010

11-
* NOTE: Windows installation is possible, but requires jumping through a few hoops. More details to come later.
12-
* Make sure you have the okapi native binaries installed on your machine. Default installation instructions are in the [readme.md here](https://github.com/trinsic-id/okapi/)
13-
* You need to have [CGO configured](https://pkg.go.dev/cmd/cgo) for the okapi native binary link
14-
* Issue the following command:
11+
!!! info "Notes: Installing the SDK for Go"
12+
13+
- Windows installation is possible, but requires jumping through a few hoops. More details to come later.
14+
- Make sure you have the okapi native binaries installed on your machine. Default installation instructions are in the [trinsic-id/okapi](https://github.com/trinsic-id/okapi/) GitHub repository.
15+
- You need to have [CGO configured](https://pkg.go.dev/cmd/cgo) for the okapi native binary link.
16+
17+
1. Run the following command:
1518
```bash
1619
go install github.com/trinsic-id/sdk/go@latest
1720
```
18-
* To test the installation, try the following go code:
19-
<!--codeinclude-->
20-
```golang
21-
[GoSample](../../samples/go/sample.go) inside_block:main
22-
```
21+
2. Test the installation by running the following go code:
22+
<!--codeinclude-->
23+
```golang
24+
[GoSample](../../samples/go/sample.go) inside_block:main
25+
```
2326
<!--/codeinclude-->
2427

2528
## Next Steps
@@ -59,4 +62,4 @@ go/pkg/mod/github.com/trinsic-id/okapi/[email protected]/okapi/didcomm.go:22:9: undefine
5962
Try running with the following env var set:
6063
```bash
6164
CGO_ENABLED=1 go test ./...
62-
```
65+
```

docs/reference/services/credential-service.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -256,7 +256,7 @@ Creates and signs a [proof](/) for a valid JSON-LD credential, using the BBS+ Si
256256
If the credential is stored in a Trinsic cloud wallet, pass its `item_id`; otherwise, pass the raw JSON-LD credential via `document_json`.
257257

258258
!!! info "Selective Disclosure"
259-
BBS+ Signatures support the ability to generate a proof for a subset of a credential's fields, instead of every field.
259+
BBS+ Signatures support the ability to generate a proof for a subset of a credential's fields, instead of every field.
260260

261261
This enables increased user privacy: fields which aren't included in `reveal_document_json` will not be present in the generated proof.
262262

0 commit comments

Comments
 (0)