docs(examples): standardize demo package documentation - #56
Merged
RafaelAPB merged 1 commit intoAug 27, 2026
Conversation
Closes hyperledger-cacti/cacti#4592 Apply the accepted package documentation structure to active examples and test packages in the Cacti Demos repository. Document each workspace's purpose, audience, installation, API surface, usage, configuration, and validation workflow. Preserve relevant architecture, container, workshop, Stellar, WS identity, and CBDC bridging guidance while removing stale commands and placeholders. Add the missing HTLC Besu test-package README, correct package names and IPFS endpoint paths, link relevant packages in the main Cacti repository, and update the root repository inventory. The repository-wide build and lint hook was skipped because the same TypeScript build failure is present on upstream/main and will be addressed separately. Assisted-by: openai:gpt-5 Signed-off-by: Parth Singh <posiedon.1721@gmail.com>
Member
Author
|
i have skipped the build and configure steps while committing and pushing as this only has documentation changes, i can look at that in a separate PR |
RafaelAPB
approved these changes
Aug 27, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes hyperledger-cacti/cacti#4592
Summary
Apply the accepted package documentation structure to active examples and test packages in the Cacti Demos repository.
Document each workspace's purpose, audience, installation, API surface, usage, configuration, and validation workflow. Preserve relevant architecture, container, workshop, Stellar, WS identity, and CBDC bridging guidance while removing stale commands and placeholders.
Add the missing HTLC Besu test-package README, correct package names and IPFS endpoint paths, link relevant packages in the main Cacti repository, and update the root repository inventory.
The repository-wide build and lint hook was skipped because the same TypeScript build failure is present on upstream
mainand will be addressed separately.Checklist
mainAssisted-bydisclosure included according toAI_GUIDELINES.md