Skip to content

Updating and expansion of README documentation for PBJ.#412

Merged
anthony-swirldslabs merged 13 commits intomainfrom
jp-update-readme
Mar 6, 2025
Merged

Updating and expansion of README documentation for PBJ.#412
anthony-swirldslabs merged 13 commits intomainfrom
jp-update-readme

Conversation

@jasperpotts
Copy link
Copy Markdown
Member

Cleanup docs, update where needed and add more.

Signed-off-by: jasperpotts <jasperpotts@users.noreply.github.com>
@jasperpotts jasperpotts requested review from a team as code owners March 6, 2025 00:22
@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 6, 2025

JUnit Test Report

   67 files  ±0     67 suites  ±0   2m 42s ⏱️ ±0s
1 272 tests ±0  1 269 ✅ ±0   3 💤 ±0  0 ❌ ±0 
7 127 runs  ±0  7 108 ✅ ±0  19 💤 ±0  0 ❌ ±0 

Results for commit 23f1f21. ± Comparison against base commit e016c45.

This pull request removes 2 and adds 1 tests. Note that renamed tests count towards both.
, 1
com.hedera.pbj.runtime.Utf8ToolsTest ‑ [4] 
com.hedera.pbj.runtime.Utf8ToolsTest ‑ [4] 
, 1

♻️ This comment has been updated with latest results.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 6, 2025

Integration Test Report

    384 files  ±0      384 suites  ±0   12m 34s ⏱️ ±0s
114 731 tests ±0  114 731 ✅ ±0  0 💤 ±0  0 ❌ ±0 
114 959 runs  ±0  114 959 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit 23f1f21. ± Comparison against base commit e016c45.

♻️ This comment has been updated with latest results.

Signed-off-by: jasperpotts <jasperpotts@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

@anthony-swirldslabs anthony-swirldslabs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good overall. I left a few comments. Also, you may want to run spotless as it complains in PR checks.

Copy link
Copy Markdown
Member

@jsync-swirlds jsync-swirlds left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for updating these.
I noticed lots of little typos, grammar and spelling slips, and homonym swaps, and commented each with a suggestion to correct.

jasperpotts and others added 10 commits March 6, 2025 10:53
Signed-off-by: jasperpotts <jasperpotts@users.noreply.github.com>
Co-authored-by: Joseph S. <121976561+jsync-swirlds@users.noreply.github.com>
Signed-off-by: Jasper Potts <1466205+jasperpotts@users.noreply.github.com>
Co-authored-by: Joseph S. <121976561+jsync-swirlds@users.noreply.github.com>
Signed-off-by: Jasper Potts <1466205+jasperpotts@users.noreply.github.com>
Co-authored-by: Joseph S. <121976561+jsync-swirlds@users.noreply.github.com>
Signed-off-by: Jasper Potts <1466205+jasperpotts@users.noreply.github.com>
Co-authored-by: Joseph S. <121976561+jsync-swirlds@users.noreply.github.com>
Signed-off-by: Jasper Potts <1466205+jasperpotts@users.noreply.github.com>
Co-authored-by: Joseph S. <121976561+jsync-swirlds@users.noreply.github.com>
Signed-off-by: Jasper Potts <1466205+jasperpotts@users.noreply.github.com>
Co-authored-by: Joseph S. <121976561+jsync-swirlds@users.noreply.github.com>
Signed-off-by: Jasper Potts <1466205+jasperpotts@users.noreply.github.com>
Co-authored-by: Joseph S. <121976561+jsync-swirlds@users.noreply.github.com>
Signed-off-by: Jasper Potts <1466205+jasperpotts@users.noreply.github.com>
Signed-off-by: jasperpotts <jasperpotts@users.noreply.github.com>
…-readme

# Conflicts:
#	pbj-core/pbj-compiler/README.md
#	pbj-core/pbj-grpc-helidon/README.md
jsync-swirlds
jsync-swirlds previously approved these changes Mar 6, 2025
Copy link
Copy Markdown
Member

@jsync-swirlds jsync-swirlds left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.

Copy link
Copy Markdown
Contributor

@anthony-swirldslabs anthony-swirldslabs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Signed-off-by: jasperpotts <jasperpotts@users.noreply.github.com>
@anthony-swirldslabs anthony-swirldslabs merged commit 8fa3199 into main Mar 6, 2025
10 checks passed
@anthony-swirldslabs anthony-swirldslabs deleted the jp-update-readme branch March 6, 2025 19:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants