Merge pull request #31 from hashgraph/docGenerationFixes

Doc generation fixes

README.md

@@ -2,30 +2,17 @@
 
 The Hedera Hashgraph API is implemented with protocol buffers, Google's language-neutral, platform-neutral, extensible mechanism for serializing structured data. This repository contains the current version of the files used to define the API.
 
-## Structure
-
-The protobuf files are organised in folders representing the domain they pertain to, the folders are:
-
-- Common - messages that form part of the core API and are used within other messages
-- Contract - messages related to the Hedera Hashgraph Smart Contract service
-- Crypto - messages related to the Hedera Hashgraph Crypto Currency service
-- File - messages related to the Hedera Hashgraph File service
-- Query - messages related to querying the Hedera Hashgraph network
-- Services - the gRPC definitions which detail which responses should be expected as a result of a request
-
 ## Documentation
 
 The protobuf files themselves contain detailed comments which help understand not only the message itself but also some of the features and capabilities of the Hedera Hashgraph network.
 
-Also available is a [HAPI.html](https://github.com/hashgraph/hedera-protobuf/blob/master/HAPI.html) document which is a HTML version of the protocol buffers file with hyperlinks to help navigate through the message definitions. It is also nested such that you can follow a complete message structure.
+The `/docs` folder of this project contains automatically generated documents in html and markdown format to help navigate through the message definitions.
 
-__Note__: the HAPI.html document is a large document and may take a few seconds to load in a browser.
+[NestedDoc.html](https://github.com/hashgraph/hedera-protobuf/blob/master/docs/NestedDoc.html) - nested HTML document to help navigate messages that contain other message definitions (large document that takes a while to open)
+[NotNestedDoc.html](https://github.com/hashgraph/hedera-protobuf/blob/master/docs/NotNestedDoc.html) - flat HTML document
+[NotNestedDoc.md](https://github.com/hashgraph/hedera-protobuf/blob/master/docs/NotNestedDoc.md) - flat markdown document
 
-## Examples
-
-Example messages can be found in the [Transaction-Query-Examples.md](https://github.com/hashgraph/hedera-protobuf/blob/master/Transaction-Query-Examples.md) file. These were generated with the [Hedera Hashgraph Java SDK](https://github.com/hashgraph/hedera-sdk-java) and may serve as a useful reference when checking if your own messages are correct.
-
-__Note__: The examples show keys and signatures. Keys shown in the examples are not the keys that were used to generate the signatures.
+__Note__: the HAPI.html document is a large document and may take a few seconds to load in a browser.
 
 ## Additional resources
 
@@ -44,8 +31,7 @@ If you are unfamiliar with protocol buffers (or need a refresher), you may consu
 
 ```shell
 cd docgenerator
-java -jar proto2html.jar "HAPI Documentation" ../src/main/proto/ ../docs/NotNestedDoc N
-java -jar proto2html.jar "HAPI Documentation" ../src/main/proto/ ../docs/NestedDoc Y
+java -jar proto2html.jar "HAPI Documentation" ../src/main/proto/ ../docs
 ```
 
 Commit all changes to github
@@ -54,4 +40,4 @@ Commit all changes to github
 
 `mvn release:perform`
 
-navigate to Nexus Repository Manager https://oss.sonatype.org/index.html#stagingRepositories and release the newly created repository.
+navigate to Nexus Repository Manager https://oss.sonatype.org/index.html#stagingRepositories and release the newly created repository.