hashgraph / hashgraph/hedera-docs

Move content from SDK docs to new "Reference" docs section

Open
#9 5 comments 2 reactions 0 assignees View on GitHub
Dominant language
MDX
Stars
10
Forks
49
Avg merge
19h 49m
Merged PRs (30d)
17

Description

### Problem

This is a proposal to create a new "References" doc section. Within that section we will move over the bulk of the content from the [SDK](https://docs.hedera.com/hedera/sdks-and-apis/sdks) and [API](https://docs.hedera.com/hedera/sdks-and-apis/rest-api) docs into these new Reference docs. For example on a page like [here](https://docs.hedera.com/hedera/sdks-and-apis/sdks/consensus-service/submit-a-message) we would move everything except the code samples into the Reference docs.

At a higher level the philosophy of the contents of the reference docs will be:
Reference docs contains propositional or theoretical knowledge that a user looks to in their work.
The only purpose of a reference guide is to describe, as succinctly as possible, and in an orderly way. Whereas the content of tutorials and how-to guides are led by needs of the user, reference material is led by the product it describes. In the case of software, reference guides describe the software itself - APIs, classes, functions and so on - and how to use them.
Source [here](https://diataxis.fr/reference/)

In contrast the SDK docs will contain guides on how to install the SDK, and guidelines on how to use the SDK functions in alignment with the reference docs. This can include code snippets and tutorials.

Feedback appreciated.

### Solution

See above.

### Alternatives

_No response_

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.