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

docs: Dev vs Master mixups #358

Merged
merged 9 commits into from
Mar 11, 2021
Merged

docs: Dev vs Master mixups #358

Changes from 6 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
cbd04f8
remove absolute link path
weichweich Mar 11, 2021
9f21b8f
add develop vs master branch warning
weichweich Mar 11, 2021
78bdf50
minor wording improvement
weichweich Mar 11, 2021
a333785
hard code link to master again
weichweich Mar 11, 2021
2630cb0
new attempt at a warning sentence
weichweich Mar 11, 2021
cf68f91
Reword again
weichweich Mar 11, 2021
4971463
bold and >
weichweich Mar 11, 2021
4b120ac
suggestions
weichweich Mar 11, 2021
dea5588
wording and link fix
weichweich Mar 11, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions packages/sdk-js/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ Regarding the privacy enhancement, please have a look at our [lightning talk for

## Documentation

* The Links found here are related to the `master` branch aka the current released version. * Links outside this section point to the version you are currently viewing.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would rather use the > tag and optionally make the sentence bold, even thought that might be too much.

Copy link
Contributor Author

@weichweich weichweich Mar 11, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah didn't had a look at the preview. It should have been bold. :D That's why there is a * in the middle of the sentence. 😁

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

current -> latest?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would write something like "to avoid confusion between the latest released SDK version and the develop default branch, the links in the list that follow point to the master branch, which always contains the latest official release of the SDK.


[KILT](https://kilt.io) documentation is provided in several guides and demos.

- [KILT workshop](https://github.com/KILTprotocol/kilt-workshop-101) 👈 Start here to get familiar with the basics
Expand All @@ -27,7 +29,7 @@ Regarding the privacy enhancement, please have a look at our [lightning talk for
- [Demo client](https://kilt.io/developers-sub/kilt-demo-client/)
- [Demo client code](https://github.com/KILTprotocol/demo-client)

To help improve, please see our [contribution page](https://github.com/KILTprotocol/sdk-js/blob/develop/docs/contribution-guide.md).
To help improve, please see our [contribution page](https://github.com/KILTprotocol/sdk-js/blob/master/docs/contribution-guide.md).

## How to install the SDK

Expand All @@ -45,7 +47,7 @@ yarn add @kiltprotocol/sdk-js

## Example

Please have a look at our examples within our [getting started guide](https://github.com/KILTprotocol/sdk-js/blob/develop/docs/getting-started.md).
Please have a look at our examples within our [getting started guide](/docs/getting-started.md).

A claim type (CTYPE) can be a credential of any kind, e.g. a drivers license, a sports club membership or even a fairtrade certificate for chocolate.

Expand All @@ -70,12 +72,12 @@ Claim {

## Development Setup

[Development Setup](https://github.com/KILTprotocol/sdk-js/blob/develop/docs/development-setup.md)
[Development Setup](/docs/development-setup.md)

## Job Board

Check to see if we have any [Job Offers](https://kilt.io/job-offers/)

## License

[License](https://github.com/KILTprotocol/sdk-js/blob/develop/LICENSE)
[License](/LICENSE)