Skip to content

docs: Refactor the What is Hiero section in _index.md#276

Merged
aceppaluni merged 2 commits intohiero-ledger:mainfrom
freya-docs:refactor-what-is-hiero
Mar 14, 2026
Merged

docs: Refactor the What is Hiero section in _index.md#276
aceppaluni merged 2 commits intohiero-ledger:mainfrom
freya-docs:refactor-what-is-hiero

Conversation

@freya-docs
Copy link
Copy Markdown
Contributor

@freya-docs freya-docs commented Mar 13, 2026

Description

This PR refactors descriptions in the What is Hiero section in _index.md

Related Issues

Closes: #263

Summary by CodeRabbit

  • Documentation
    • Revised five platform characteristic descriptions to be shorter, clearer, and more direct (fair, fast, secure, decentralized, leaderless, open).
    • Minor stylistic and punctuation tweaks to improve readability; content placement and section structure unchanged.

Signed-off-by: freya-docs <freya.docs.pp@gmail.com>
@freya-docs freya-docs requested review from a team as code owners March 13, 2026 10:56
@netlify
Copy link
Copy Markdown

netlify bot commented Mar 13, 2026

Deploy Preview for hiero-open-source ready!

Name Link
🔨 Latest commit f4dff92
🔍 Latest deploy log https://app.netlify.com/projects/hiero-open-source/deploys/69b3f1e9a8ae5a00084a7de8
😎 Deploy Preview https://deploy-preview-276--hiero-open-source.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@lfdt-bot
Copy link
Copy Markdown
Contributor

lfdt-bot commented Mar 13, 2026

Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
Open Source Security 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 13, 2026

📝 Walkthrough

Walkthrough

Condensed the six "What is Hiero?" homepage points (fair, fast, secure, decentralized, leaderless, open) into shorter, scannable statements; no structural changes to sections, icons, or exported/public signatures.

Changes

Cohort / File(s) Summary
Homepage Content
content/_index.md
Shortened six section_what_is_hiero_points entries (fair, fast, secure, decentralized, leaderless, open) for brevity and improved scan-ability; minor punctuation/stylistic tweaks only.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested labels

status: awaiting developer revision

Suggested reviewers

  • exploreriii
  • aceppaluni

Poem

🐰 I nibble words and make them light,
Trimming lines till meanings bite.
Short hops, clear thoughts — a brighter site,
Less to read, and all feels right. ✨

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name Status Explanation Resolution
Out of Scope Changes check ⚠️ Warning The changes are limited to refactoring text in the What is Hiero section; however, critical acceptance criteria from issue #263 appear unmet: no changelog entry or DCO/GPG-signed commits are documented. Verify and document that a changelog entry has been added and commits are properly DCO/GPG-signed to meet all acceptance criteria from issue #263.
Description check ❓ Inconclusive The PR description is incomplete; it omits several required template sections including Changes Made, Screenshots, Checklist, and Deployment Notes. Fill out the complete description template with a detailed Changes Made section listing all refactored subsections, and confirm the Checklist items were verified.
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately and concisely describes the main change: refactoring the What is Hiero section in _index.md to make descriptions briefer.
Linked Issues check ✅ Passed The PR successfully refactors all six subsections (fair, fast, secure, decentralized, leaderless, open) to be much more concise while retaining key messages, directly addressing issue #263's primary objective.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
📝 Coding Plan
  • Generate coding plan for human review comments

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Tip

You can get early access to new features in CodeRabbit.

Enable the early_access setting to enable early access features such as new models, tools, and more.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (1)
content/_index.md (1)

247-247: Improve phrasing for technical accuracy.

The phrase "secure from denial-of-service and centralization" is technically imprecise. Systems are typically described as "resistant to" attacks or "designed to prevent" centralization, not "secure from" them. Consider rephrasing for better technical accuracy.

✍️ Suggested improvement
-text = "Leader-based consensus is unfair and either slow or vulnerable to attacks. We believe in a fully leaderless protocol where every node participates equally. Our protocol is secure from denial-of-service and centralization."
+text = "Leader-based consensus is unfair and either slow or vulnerable to attacks. We believe in a fully leaderless protocol where every node participates equally. Our protocol is resistant to denial-of-service attacks and prevents centralization."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@content/_index.md` at line 247, Update the text string assigned to text to
use technically accurate phrasing: replace "secure from denial-of-service and
centralization" with wording like "resistant to denial-of-service attacks and
designed to prevent centralization" (or "reduce centralization risk"), and
ensure the full sentence reads clearly — e.g. keep the claim about a fully
leaderless protocol where every node participates equally and then state it
"improves resistance to denial-of-service attacks and reduces centralization
risk."
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@content/_index.md`:
- Around line 227-237: The three [[section_what_is_hiero_points]] blocks
(identified by the headings "Hiero is <strong>fair</strong>", "Hiero is
<strong>fast</strong>", and "Hiero is <strong>secure</strong>") use inconsistent
capitalization of the term "hashgraph"/"Hashgraph"; update the text fields so
they consistently use lowercase "hashgraph" when referring to the algorithm
(e.g., change "Hashgraph is leaderless" to "hashgraph is leaderless") and ensure
all occurrences in these text properties match that convention.

---

Nitpick comments:
In `@content/_index.md`:
- Line 247: Update the text string assigned to text to use technically accurate
phrasing: replace "secure from denial-of-service and centralization" with
wording like "resistant to denial-of-service attacks and designed to prevent
centralization" (or "reduce centralization risk"), and ensure the full sentence
reads clearly — e.g. keep the claim about a fully leaderless protocol where
every node participates equally and then state it "improves resistance to
denial-of-service attacks and reduces centralization risk."

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 62593bc7-b0a9-4f8a-bc83-8fd7b5078962

📥 Commits

Reviewing files that changed from the base of the PR and between 568331d and 466a5bf.

📒 Files selected for processing (1)
  • content/_index.md

Signed-off-by: freya-docs <freya.docs.pp@gmail.com>
@freya-docs freya-docs changed the title docs: Refactor descriptions in _index.md docs: Refactor the What is Hiero section in _index.md Mar 13, 2026
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

♻️ Duplicate comments (1)
content/_index.md (1)

227-227: ⚠️ Potential issue | 🟡 Minor

Inconsistent capitalization of "Hashgraph".

This line uses "Hashgraph" (capitalized), while lines 232 and 237 consistently use "hashgraph" (lowercase) when referring to the algorithm. For consistency, standardize to lowercase "hashgraph" throughout.

📝 Suggested fix for consistency
-text = "Public forums should be equally accessible. No one should manipulate your transactions to their advantage. Hashgraph is leaderless - toward a fairer world."
+text = "Public forums should be equally accessible. No one should manipulate your transactions to their advantage. The hashgraph algorithm is leaderless - toward a fairer world."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@content/_index.md` at line 227, Update the capitalization in the string
assigned to text (the line containing text = "Public forums should be equally
accessible. No one should manipulate your transactions to their advantage.
Hashgraph is leaderless - toward a fairer world.") to use lowercase "hashgraph"
so it matches other occurrences; edit the quoted sentence accordingly to replace
"Hashgraph" with "hashgraph".
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Duplicate comments:
In `@content/_index.md`:
- Line 227: Update the capitalization in the string assigned to text (the line
containing text = "Public forums should be equally accessible. No one should
manipulate your transactions to their advantage. Hashgraph is leaderless -
toward a fairer world.") to use lowercase "hashgraph" so it matches other
occurrences; edit the quoted sentence accordingly to replace "Hashgraph" with
"hashgraph".

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 94d030dc-38d9-4fbe-bb9e-a771f6581682

📥 Commits

Reviewing files that changed from the base of the PR and between 466a5bf and f4dff92.

📒 Files selected for processing (1)
  • content/_index.md

Copy link
Copy Markdown
Contributor

@exploreriii exploreriii left a comment

Choose a reason for hiding this comment

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

Hi i think you have done an amazing job at preserving the original meaning but writing in it less words, will pass to @aceppaluni for a second opinion

@exploreriii exploreriii requested a review from aceppaluni March 14, 2026 09:09
Copy link
Copy Markdown
Contributor

@aceppaluni aceppaluni left a comment

Choose a reason for hiding this comment

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

@freya-docs Thank you so much for working on this. This looks great to me.

I will Merge!

@aceppaluni aceppaluni merged commit 11aa3fa into hiero-ledger:main Mar 14, 2026
15 checks passed
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.

[Intermediate]: Refactor the What is Hiero? Hiero is fair... etc sections to be briefer

4 participants