Improve README quick start and fix documentation issues#2
Conversation
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 6935e16b87
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
|
||
| ```java | ||
| import org.hiero.spring.EnableHiero; | ||
| import com.open.elements.spring.hiero.EnableHiero; |
There was a problem hiding this comment.
The usage snippet now imports com.open.elements.spring.hiero.EnableHiero, but that package does not exist in this repository (EnableHiero is defined under org.hiero.spring). Anyone copying this sample will hit an unresolved import and fail to bootstrap the Spring integration, so the README should keep the org.hiero.spring.EnableHiero import path.
Useful? React with 👍 / 👎.
| - `org.hiero.base.verifcation.ContractVerificationClient`: to verify smart contracts | ||
| - `base.org.hiero.mirrornode.AccountRepository`: to query accounts | ||
| - `base.org.hiero.mirrornode.NetworkRepository`: to query network information |
There was a problem hiding this comment.
This section now lists non-existent FQCNs (org.hiero.base.verifcation... and base.org.hiero...), which are typos/inversions of the real package layout used by the codebase (org.hiero.base.verification, org.hiero.base.mirrornode, org.hiero.base.protocol). As written, developers cannot import the documented services, so these names should be corrected to the actual namespaces.
Useful? React with 👍 / 👎.
| The sample application is a simple Spring Boot application that reads has a REST endpoint at `localhost:8080/` and shows the hbar balance of the account `0.0.100` on the Hedera testnet. | ||
| To use the application, you need to have created a Hedera testnet account at the [Hedera portal](https://portal.hedera.com/). | ||
| The account information can be added to the `application.properties` file in the `hiero-enterprise-spring-sample` module: | ||
| The account information can be added to the `application.properties` file in the `hedera-spring-sample` module: |
There was a problem hiding this comment.
The README now tells users to edit properties in hedera-spring-sample, but this repo’s sample module is hiero-enterprise-spring-sample. Following the current text sends users to a non-existent path and blocks quick-start setup, so the module reference should match the actual directory.
Useful? React with 👍 / 👎.
1 participant
Motivation
org.hierocode structure.Description
Quick startsection at the top ofREADME.md:hiero-enterprise-springfor Spring Boothiero-enterprise-microprofilefor MicroProfile/Quarkusdocs/for full documentationimport org.hiero.spring.EnableHiero;org.hiero.base.verification.ContractVerificationClientorg.hiero.base.mirrornode.*org.hiero.base.protocol.ProtocolLayerClientTesting
README.md.