search

hashgraph / hedera-services

Crypto, token, consensus, file, and smart contract services for the Hedera public ledger
Apache License 2.0
266 stars 118 forks source link

Refactor and Remove Duplicate Documentation in Services #13917

Open thomas-swirlds-labs opened 3 weeks ago

thomas-swirlds-labs commented 3 weeks ago

There are multiple different versions of several pages, under /docs at the top level of the repo and inside hedera-node /docs contains for example:

1 - Maintainers guide

  1 - [top level]         https://github.com/hashgraph/hedera-services/blob/develop/docs/maintainers-guide.md
  2 - [hedera-node level] https://github.com/hashgraph/hedera-services/blob/1d21a02aeaf2edfea90101b03a254938bee6caf4/hedera-node/docs/maintainers-guide.md

2 - IntelliJ quickstart

  1 - [top level]         https://github.com/hashgraph/hedera-services/blob/develop/docs/intellij-quickstart.md   
  2 - [hedera-node level] https://github.com/hashgraph/hedera-services/blob/1d21a02aeaf2edfea90101b03a254938bee6caf4/hedera-node/docs/intellij-quickstart.md

3 - Hedera Java Style guide, etc.

One version of each seems to be getting maintained and updated on more frequent basis than the other ones and the fact that there are duplicate documents at all leads to inconsistencies and is confusing for community developers.

We should also consider creating a readme or similar at the root of hedera-node /docs to at least act as a guide map or table of contents for the contained sub pages.