Feat/chore: update for 0.6 #611
Conversation
WalkthroughAdds a Holochain 0.5→0.6 upgrade guide and navigation entry; updates docs and examples for 0.6 (manifests, path-based zome/hApp locations, dependency versions); replaces link API examples with LinkQuery/GetStrategy and renames get_link_details→get_links_details; updates Netlify link-check config, 11ty diff rendering, infra scripts, and removes a hashing subsection. Changes
Estimated code review effort🎯 4 (Complex) | ⏱️ ~45 minutes Areas to pay extra attention to:
Possibly related PRs
Suggested reviewers
Pre-merge checks and finishing touches❌ Failed checks (1 warning, 1 inconclusive)
✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
src/pages/resources/upgrade/upgrade-holochain-0.6.md (1)
8-8: Minor wordiness: consider alternative phrasings.LanguageTool flagged two style suggestions:
- Line 8: "biggest change" could use a stronger alternative (e.g., "primary change", "major change", "key change")
- Line 182: "exact same query predicates" could be shortened to "same query predicates"
These are optional refinements for stylistic polish.
Also applies to: 182-182
src/pages/build/links-paths-and-anchors.md (1)
104-104: Minor wordiness in info box.The phrase "In order to validate" could be shortened to "To validate" for more concise writing.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (8)
netlify.toml(1 hunks)src/pages/build/dnas.md(3 hunks)src/pages/build/happs.md(6 hunks)src/pages/build/links-paths-and-anchors.md(7 hunks)src/pages/resources/howtos/debugging.md(1 hunks)src/pages/resources/howtos/running-network-infrastructure.md(1 hunks)src/pages/resources/upgrade/index.md(1 hunks)src/pages/resources/upgrade/upgrade-holochain-0.6.md(1 hunks)
🧰 Additional context used
🪛 GitHub Actions: Check spelling
src/pages/resources/howtos/running-network-infrastructure.md
[warning] 153-153: Unknown word (getrandom)
src/pages/resources/upgrade/upgrade-holochain-0.6.md
[warning] 260-260: Unknown word (getrandom)
🪛 GitHub Check: spellcheck
src/pages/resources/howtos/running-network-infrastructure.md
[warning] 153-153:
Unknown word (getrandom)
src/pages/resources/upgrade/upgrade-holochain-0.6.md
[warning] 260-260:
Unknown word (getrandom)
🪛 LanguageTool
src/pages/resources/upgrade/upgrade-holochain-0.6.md
[style] ~8-~8: The word ‘biggest’ tends to be overused. Consider an alternative.
Context: ... guide to get you upgraded to 0.6. The biggest change in Holochain 0.6 is that warrants a...
(BIG_DIFFERENCE)
[style] ~182-~182: ‘exact same’ might be wordy. Consider a shorter alternative.
Context: ...ith count_links, so you can apply the exact same query predicates with ease. ```diff:ru...
(EN_WORDINESS_PREMIUM_EXACT_SAME)
[grammar] ~256-~256: Ensure spelling is correct
Context: ...onment variable. Edit this line in your hApp's root package.json file: ```diff:json...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
src/pages/build/links-paths-and-anchors.md
[style] ~104-~104: Consider a more concise word here.
Context: ...``` !!! info Specifying a get strategy In order to validate a link deletion action, the or...
(IN_ORDER_TO_PREMIUM)
🪛 markdownlint-cli2 (0.18.1)
src/pages/resources/upgrade/upgrade-holochain-0.6.md
182-182: Bare URL used
(MD034, no-bare-urls)
🔇 Additional comments (11)
netlify.toml (1)
188-188: Redirect updated to point to latest upgrade guide.The temporary "latest" redirect now correctly points to the new 0.6 upgrade guide, enabling users to access the most current upgrade path at
/resources/upgrade/latest/.src/pages/resources/howtos/debugging.md (1)
162-162: Manifest location field updated to reflect 0.6 format.The
AppRoleDnaManifestexample output correctly shows thePathfield instead ofBundled, consistent with the manifest format changes in Holochain 0.6.src/pages/resources/howtos/running-network-infrastructure.md (2)
153-153: RUSTFLAGS environment variable required for Holochain 0.6 zome compilation.The new environment variable flag is necessary for building WASM zomes in Holochain 0.6 due to a dependency change. This aligns with the upgrade guide and the corresponding change in the root
package.jsonconfiguration.
153-153: Now let me check how cspell is actually being used in those existing files to understand the project's pattern:Based on my investigation, I have verified:
- "getrandom" is a legitimate Rust configuration where opt-in backends can be enabled using the getrandom_backend configuration flag.
- The RUSTFLAGS syntax shown in the review (
--cfg getrandom_backend="custom") is valid and idiomatic for Rust builds.- In Markdown files, cSpell allows blocking code by wrapping it in HTML comments:
<!-- cSpell:disable -->and<!-- cSpell:enable -->, or adding a cSpell directive at the end of the file using the pattern<!-- cspell:ignore word -->with 3 dashes to prevent generating HTML comments.The review comment is accurate—"getrandom" is a domain-specific technical term (part of a Rust crate name and backend configuration) that spell checkers understandably flag. The suggested solutions of adding a cspell-disable comment or dictionary entry are both appropriate approaches.
Address persistent spelling check warning for "getrandom" in the RUSTFLAGS configuration.
The warning for "getrandom" (a backend name used in the Rust build configuration) can be resolved by adding a per-file directive. Add the following HTML comment near the top or end of the file:
<!-- cspell:ignore getrandom -->Alternatively, if a cspell.json config exists in the project, add "getrandom" to the words list to suppress it project-wide.
src/pages/build/dnas.md (1)
42-42: Manifest format correctly updated for Holochain 0.6.The DNA manifest examples have been updated to reflect version 0.6 format changes:
- Version number updated to
'0'- Zome location fields changed from
bundledtopathacross both integrity and coordinator sections- Descriptor text clarified to explain that
pathindicates the filesystem location to be bundled by the packagerThese changes align with the broader manifest simplification in 0.6 and are consistent with related updates in
happs.md.Also applies to: 52-52, 57-57, 71-71
src/pages/resources/upgrade/upgrade-holochain-0.6.md (2)
233-251: Manifest format changes section may cause confusion.The diff at lines 245-251 shows both
bundledandpathfields simultaneously:dna: - bundled: ../dnas/forum/workdir/forum.dna - path: ../dnas/forum/workdir/forum.dnaThis looks like both fields exist in the same version. Clarify that in 0.6 the
bundledfield is removed and replaced entirely bypath. Consider updating the diff to be clearer:dna: - bundled: ../dnas/forum/workdir/forum.dna + path: ../dnas/forum/workdir/forum.dna
174-220: API changes section is comprehensive and well-documented.The breaking changes for
get_link_details→get_links_details, links query consolidation, anddelete_linkGetOptions requirement are clearly explained with before/after code examples. The examples correctly show:
- LinkQuery builder pattern usage
- GetStrategy parameter
- Filter and collector patterns
src/pages/resources/upgrade/index.md (1)
13-15: Upgrade index correctly positioned for new 0.5→0.6 guide.The new upgrade entry is properly placed at the top of the list, making it discoverable first. The link path correctly references the new upgrade guide file. This aligns with the netlify.toml redirect update.
src/pages/build/happs.md (1)
20-20: hApp and web hApp manifests correctly updated for 0.6.All manifest examples have been consistently updated:
- holonix reference: Updated to
main-0.6(line 20)- Manifest versions: Changed from
'1'to'0'for both hApp and web hApp- Location fields: Changed from
bundledtopathacross all DNA and UI references- Descriptor text: Updated to reflect that
pathindicates the filesystem location to be bundled by the packagerThese changes maintain consistency with the DNA manifest updates and the upgrade guide.
Also applies to: 40-40, 49-49, 60-60, 85-85, 108-108, 111-111, 113-113, 119-119
src/pages/build/links-paths-and-anchors.md (2)
98-106: Link deletion API updated with required GetOptions parameter.The
delete_linkfunction now requires aGetOptionsargument, and the accompanying info box clearly explains:
- When to use
GetOptions::network()(when you don't have the original link action locally)- When to use
GetOptions::local()(when the agent created the link)- Why this is necessary (to enable validation of the deletion action)
This addresses the validation issue described in the upgrade guide.
127-127: Links query API consolidation implemented consistently.All examples have been updated to use the new unified
LinkQueryandGetStrategyAPI:
get_linksexamples (lines 135-152) show LinkQuery construction with filteringget_links_details(formerlyget_link_details) examples show consistent usagecount_linksexamples updated to use LinkQuery builder pattern- Path traversal examples (lines 253-280) all use the new API
The code examples are syntactically correct and demonstrate the new builder pattern well.
Also applies to: 135-163, 177-186
pdaoust
force-pushed
the
feat/upgrade-guide-0.6
branch
from
701f9d1 to
ef7eb67
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
src/pages/resources/upgrade/upgrade-holochain-0.6.md (1)
176-220: API migration examples are clear and well-documented.The before/after code diffs effectively illustrate the link query consolidation and the new GetStrategy parameter. However, line 182 has a markdown formatting issue with the
get_links_detailslink.Line 182 contains a broken markdown link:
[get_links_details] (...)has an unwanted space between]and(. Apply this fix:-[`get_links`](https://docs.rs/hdk/latest/hdk/link/fn.get_links.html) and [`get_links_details`] (https://docs.rs/hdk/latest/hdk/link/fn.get_links_details.html) now share a similar API +[`get_links`](https://docs.rs/hdk/latest/hdk/link/fn.get_links.html) and [`get_links_details`](https://docs.rs/hdk/latest/hdk/link/fn.get_links_details.html) now share a similar API
🧹 Nitpick comments (1)
src/pages/build/links-paths-and-anchors.md (1)
104-106: Minor: Simplify verbose language in info box.The phrase "In order to validate" can be more concise.
-In order to validate a link deletion action, the original link creation action has to be available locally --- otherwise validation will fail with [`UnresolvedDependencies`](/build/validate-callback/#validation-outcomes). If you know that the original link will be available --- for instance, in cases where the agent is deleting a link they created --- you can use `GetOptions::local()`; otherwise, always use `GetOptions::network()`. +To validate a link deletion action, the original link creation action has to be available locally --- otherwise validation will fail with [`UnresolvedDependencies`](/build/validate-callback/#validation-outcomes). If you know that the original link will be available --- for instance, in cases where the agent is deleting a link they created --- you can use `GetOptions::local()`; otherwise, always use `GetOptions::network()`.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (9)
.cspell/custom-words.txt(1 hunks)netlify.toml(1 hunks)src/pages/build/dnas.md(3 hunks)src/pages/build/happs.md(6 hunks)src/pages/build/links-paths-and-anchors.md(7 hunks)src/pages/resources/howtos/debugging.md(1 hunks)src/pages/resources/howtos/running-network-infrastructure.md(1 hunks)src/pages/resources/upgrade/index.md(1 hunks)src/pages/resources/upgrade/upgrade-holochain-0.6.md(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- .cspell/custom-words.txt
🚧 Files skipped from review as they are similar to previous changes (4)
- src/pages/resources/howtos/debugging.md
- netlify.toml
- src/pages/resources/upgrade/index.md
- src/pages/build/dnas.md
🧰 Additional context used
🪛 LanguageTool
src/pages/build/links-paths-and-anchors.md
[style] ~104-~104: Consider a more concise word here.
Context: ...``` !!! info Specifying a get strategy In order to validate a link deletion action, the or...
(IN_ORDER_TO_PREMIUM)
src/pages/resources/upgrade/upgrade-holochain-0.6.md
[style] ~8-~8: The word ‘biggest’ tends to be overused. Consider an alternative.
Context: ... guide to get you upgraded to 0.6. The biggest change in Holochain 0.6 is that warrants a...
(BIG_DIFFERENCE)
[style] ~182-~182: ‘exact same’ might be wordy. Consider a shorter alternative.
Context: ...ith count_links, so you can apply the exact same query predicates with ease. ```diff:ru...
(EN_WORDINESS_PREMIUM_EXACT_SAME)
[grammar] ~256-~256: Ensure spelling is correct
Context: ...onment variable. Edit this line in your hApp's root package.json file: ```diff:json...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🪛 markdownlint-cli2 (0.18.1)
src/pages/build/happs.md
112-112: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Redirect rules - developer-portal-production
- GitHub Check: Header rules - developer-portal-production
- GitHub Check: Pages changed - developer-portal-production
🔇 Additional comments (11)
src/pages/build/links-paths-and-anchors.md (1)
99-186: API updates are consistent and well-documented throughout.The migration from
GetLinksInputBuildertoLinkQuery::try_new(...)+GetStrategy::default()is applied uniformly across all examples:
delete_linkexamples now correctly passGetOptions::network()(line 99–101)get_linksandget_links_detailsconsistently use the new two-parameter form (lines 135–137, 160–163, 253–258, 275–280)count_linkscorrectly usesLinkQuerybuilder pattern (lines 177–186)- The new info box (lines 104–106) provides helpful guidance on when to use
GetOptions::local()vs.GetOptions::network()The documentation clearly reflects the 0.6 API changes without introducing inconsistencies or gaps.
src/pages/resources/howtos/running-network-infrastructure.md (1)
153-153: RUSTFLAGS update aligns with upgrade guide.The zome build script update adds the required environment variable for Holochain 0.6 compatibility, consistent with the documented changes in the upgrade guide.
src/pages/build/happs.md (3)
40-40: Manifest version updated consistently.Both hApp and web hApp manifests correctly reflect the version change to
'0', aligning with the upgrade guide documentation.Also applies to: 108-108
49-49: DNA/UI locations correctly updated topathsemantics.All location references now use
pathfor filesystem locations at package build time, with the packager handling the bundling. Changes are consistent across hApp and web hApp manifests and align with upgrade documentation.Also applies to: 60-60, 111-111, 113-113
20-20: Scaffolding version correctly updated to 0.6.The holonix reference has been properly updated to use the 0.6 release channel.
src/pages/resources/upgrade/upgrade-holochain-0.6.md (6)
1-9: Intro section is clear and well-structured.The opening properly frames the upgrade scope. Minor style note: the static analysis tool suggests "biggest" may be overused; consider "primary" or "key" as alternatives.
11-98: Quick instructions are clear and well-structured.The sequential steps with embedded diffs make it easy for users to follow the upgrade process. Version updates are consistent throughout.
101-172: Dependency update instructions are comprehensive.Clear guidance on Rust and JavaScript dependencies, with helpful distinctions between required and optional updates. Version numbers are well-documented.
233-252: Manifest format changes are well-explained.The section clearly documents the
manifest_versionupdate and the transition frombundledtopathfields, with helpful diffs. Changes are consistent with other documentation updates.
254-261: RUSTFLAGS requirement is clearly documented.The new environment variable requirement is well-explained and matches the corresponding update in the build guide. The reason for the change adds helpful context.
263-266: Subtle changes section appropriately acknowledges non-breaking but notable changes.The note about Holo WebSDK removal is important for developers. This section could potentially expand with additional migration guidance if needed.
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (3)
src/pages/resources/upgrade/upgrade-holochain-0.6.md (2)
8-8: Consider more precise language for technical documentation.The phrase "biggest change" is colloquial; consider alternatives like "most significant change" for professional documentation consistency.
257-263: Clarify the hApp manifest field name change.The diff could be clearer: line 261 removes
bundled:and line 262 addspath:, but they point to the same value. Consider adding a comment explaining this is a field rename, not a path change.Consider adding inline commentary:
dna: - bundled: ../dnas/forum/workdir/forum.dna + path: ../dnas/forum/workdir/forum.dna # Renamed from 'bundled' to 'path' modifiers: # ...src/pages/build/links-paths-and-anchors.md (1)
104-106: Minor: Simplify opening phrase in info box.The phrase "In order to" is slightly wordy; consider "To validate a link deletion..." for conciseness.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
src/pages/build/links-paths-and-anchors.md(7 hunks)src/pages/resources/upgrade/upgrade-holochain-0.6.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
src/pages/build/links-paths-and-anchors.md
[style] ~104-~104: Consider a more concise word here.
Context: ...``` !!! info Specifying a get strategy In order to validate a link deletion action, the or...
(IN_ORDER_TO_PREMIUM)
src/pages/resources/upgrade/upgrade-holochain-0.6.md
[style] ~8-~8: The word ‘biggest’ tends to be overused. Consider an alternative.
Context: ... guide to get you upgraded to 0.6. The biggest change in Holochain 0.6 is that warrants a...
(BIG_DIFFERENCE)
[style] ~194-~194: ‘exact same’ might be wordy. Consider a shorter alternative.
Context: ...ith count_links, so you can apply the exact same query predicates with ease. ```diff:ru...
(EN_WORDINESS_PREMIUM_EXACT_SAME)
🔇 Additional comments (7)
src/pages/resources/upgrade/upgrade-holochain-0.6.md (2)
115-121: Verify Cargo.toml version downgrade logic.The example shows downgrading patch versions (hdi 0.6.3→0.6.0, hdk 0.5.3→0.5.0) rather than upgrading. While the comment indicates users can pick later versions, this seems counterintuitive for an upgrade guide. Verify that these base versions are correct and document the reasoning.
75-76: Good: RUSTFLAGS workaround properly documented.The addition of the getrandom backend configuration flag addresses a known build dependency issue and is correctly integrated into the build script.
src/pages/build/links-paths-and-anchors.md (5)
127-152: Good: get_links API update correctly documented.The new LinkQuery and GetStrategy parameters are properly shown with clear examples of both basic and filtered link retrieval. Consistent with upgrade guide.
154-164: Good: get_links_details API properly updated.The renamed function and new parameter signature (LinkQuery, GetStrategy) are correctly documented with a clear example.
168-186: Good: count_links API and behavior clearly documented.The LinkQuery usage is correctly shown, and the note about always querying the network (without configurable strategy) is helpful transparency about current limitations.
250-286: Good: Path examples updated with new LinkQuery/GetStrategy API.Both the path retrieval and child path iteration examples correctly use the updated API signatures.
305-306: Good: Reference section correctly updated.The renamed function reference is properly updated in the documentation links.
| ### Count links | ||
|
|
||
| If all you need is a _count_ of matching links, use [`hdk::link::count_links`](https://docs.rs/hdk/latest/hdk/link/fn.count_links.html). It has a different input with more options for querying (we'll likely update the inputs of `get_links` and `count_links` to match in the future). | ||
| If all you need is a _count_ of matching links, use [`hdk::link::count_links`](https://docs.rs/hdk/latest/hdk/link/fn.count_links.html). Currently it lacks the ability to specify a get strategy and will always go to the network; we may allow you to configure this in the future. |
There was a problem hiding this comment.
I looked through the code and believe this is correct?
|
build is currently failing because of a broken link to Don't merge until we're ready to live with 0.6 -- first, update exact version numbers, then merge. |
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
src/pages/resources/upgrade/upgrade-holochain-0.6.md (1)
13-13: Fix version reference in upgrade instructions.Line 13 should reference upgrading FROM 0.5, not for 0.6. Users need to know which version they're starting from.
Apply this fix:
-To upgrade your hApp written for Holochain 0.6, follow these steps: +To upgrade your hApp written for Holochain 0.5, follow these steps:
🧹 Nitpick comments (1)
src/pages/resources/upgrade/upgrade-holochain-0.6.md (1)
257-264: Clarify the manifest diff to avoid confusion.The diff showing the
bundled→pathchange is misleading. Currently it displays bothbundledandpathin the "before" section, suggesting both existed previously. This should only show replacingbundledwithpath:dna: - bundled: ../dnas/forum/workdir/forum.dna + path: ../dnas/forum/workdir/forum.dna modifiers: # ...This clarifies that you're replacing one field with the other, not removing and re-adding.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
src/pages/resources/upgrade/upgrade-holochain-0.6.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
src/pages/resources/upgrade/upgrade-holochain-0.6.md
[style] ~8-~8: The word ‘biggest’ tends to be overused. Consider an alternative.
Context: ... guide to get you upgraded to 0.6. The biggest change in Holochain 0.6 is that warrants a...
(BIG_DIFFERENCE)
[style] ~194-~194: ‘exact same’ might be wordy. Consider a shorter alternative.
Context: ...ith count_links, so you can apply the exact same query predicates with ease. ```diff:ru...
(EN_WORDINESS_PREMIUM_EXACT_SAME)
🪛 markdownlint-cli2 (0.18.1)
src/pages/resources/upgrade/upgrade-holochain-0.6.md
115-115: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
127-127: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
137-137: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
155-155: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
172-172: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
182-182: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
196-196: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
240-240: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
251-251: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
259-259: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Redirect rules - developer-portal-production
- GitHub Check: Header rules - developer-portal-production
- GitHub Check: Pages changed - developer-portal-production
🔇 Additional comments (1)
src/pages/resources/upgrade/upgrade-holochain-0.6.md (1)
117-121: Verify hdk version number in Cargo.toml update.Line 120 shows hdk being pinned to
=0.5.0, which appears inconsistent with a 0.6 upgrade where hdi is being updated to=0.6.0. For a major version upgrade, both packages typically move together. Line 113's TODO comment suggests version numbers may still need finalization.Please confirm whether hdk should also be
=0.6.0or if0.5.0is intentional.
zippy
left a comment
zippy
left a comment
There was a problem hiding this comment.
Missing the "AppBundle::decode -> ::unpack"
Also I believe there are AppInfo changes, can you check that?
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
src/pages/resources/upgrade/upgrade-holochain-0.6.md (1)
13-13: Fix: Reference version FROM which users are upgrading.Line 13 still contains the error from the previous review. The text should reference "Holochain 0.5" (the source), not "0.6" (the destination).
Apply this fix:
-To upgrade your hApp written for Holochain 0.6, follow these steps: +To upgrade your hApp written for Holochain 0.5, follow these steps:
🧹 Nitpick comments (1)
src/pages/resources/upgrade/upgrade-holochain-0.6.md (1)
8-8: Minor: Consider rephrasing to avoid overused phrasing.The phrase "biggest change" is flagged by static analysis as commonly overused. Consider a more specific alternative like "most significant" or "primary" to add clarity.
-The biggest change in Holochain 0.6 is that **warrants** are now stable. +The most significant change in Holochain 0.6 is that **warrants** are now stable.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
src/pages/resources/upgrade/upgrade-holochain-0.6.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
src/pages/resources/upgrade/upgrade-holochain-0.6.md
[style] ~8-~8: The word ‘biggest’ tends to be overused. Consider an alternative.
Context: ... guide to get you upgraded to 0.6. The biggest change in Holochain 0.6 is that warrants a...
(BIG_DIFFERENCE)
[style] ~194-~194: ‘exact same’ might be wordy. Consider a shorter alternative.
Context: ...ith count_links, so you can apply the exact same query predicates with ease. ```diff:ru...
(EN_WORDINESS_PREMIUM_EXACT_SAME)
🪛 markdownlint-cli2 (0.18.1)
src/pages/resources/upgrade/upgrade-holochain-0.6.md
115-115: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
127-127: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
137-137: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
155-155: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
172-172: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
182-182: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
196-196: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
240-240: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
251-251: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
259-259: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
270-270: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
pdaoust
force-pushed
the
feat/upgrade-guide-0.6
branch
from
78147e7 to
2a0ab90
Compare
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (4)
src/pages/resources/upgrade/upgrade-holochain-0.6.md (4)
1-11: Consider alternative to "biggest change."Line 8 uses "biggest" which is common phrasing but slightly informal. Consider rewording for clarity, e.g., "The primary change" or "The main change" if the tone should be more formal.
77-78: Document RUSTFLAGS workaround more explicitly.The
getrandom_backend=\"custom\"flag is added to handle an HDK dependency, but the reason isn't immediately clear. Consider updating the comment on line 55 to explain what this RUSTFLAGS setting fixes and whether it's temporary or permanent for 0.6.
190-234: Tighten wording: "exact same" can be simplified.Line 196 uses "exact same query predicates with ease" which is slightly redundant. Consider: "the same query predicates" or "identical query predicates" for conciseness.
240-240: TODO: Future improvement tracked fordelete_link.Line 240 notes a pending enhancement to use
GetStrategyinstead ofGetOptions. This can be tracked separately and addressed in a follow-up once the underlying issue is resolved.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
src/pages/resources/upgrade/upgrade-holochain-0.3.md(1 hunks)src/pages/resources/upgrade/upgrade-holochain-0.4.md(1 hunks)src/pages/resources/upgrade/upgrade-holochain-0.5.md(1 hunks)src/pages/resources/upgrade/upgrade-holochain-0.6.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
src/pages/resources/upgrade/upgrade-holochain-0.6.md
[style] ~8-~8: The word ‘biggest’ tends to be overused. Consider an alternative.
Context: ... guide to get you upgraded to 0.6. The biggest change in Holochain 0.6 is that warrants a...
(BIG_DIFFERENCE)
[style] ~196-~196: ‘exact same’ might be wordy. Consider a shorter alternative.
Context: ...ith count_links, so you can apply the exact same query predicates with ease. ```diff:ru...
(EN_WORDINESS_PREMIUM_EXACT_SAME)
🪛 markdownlint-cli2 (0.18.1)
src/pages/resources/upgrade/upgrade-holochain-0.6.md
224-224: Link text should be descriptive
(MD059, descriptive-link-text)
252-252: Link text should be descriptive
(MD059, descriptive-link-text)
268-268: Link text should be descriptive
(MD059, descriptive-link-text)
272-272: Link text should be descriptive
(MD059, descriptive-link-text)
297-297: Link text should be descriptive
(MD059, descriptive-link-text)
298-298: Link text should be descriptive
(MD059, descriptive-link-text)
300-300: Link text should be descriptive
(MD059, descriptive-link-text)
🔇 Additional comments (7)
src/pages/resources/upgrade/upgrade-holochain-0.4.md (1)
9-10: Helpful prerequisite guidance for multi-step upgrade paths.The addition correctly signals to users upgrading from Holochain 0.2 that they must follow the 0.3 upgrade guide first. The link path follows established conventions in the codebase and the target file exists. This is well-placed within the intro block and aligns with the cascading upgrade narrative.
src/pages/resources/upgrade/upgrade-holochain-0.5.md (1)
9-10: Upgrade guide sequencing improves user guidance.This note ensures users on older versions follow the prerequisite upgrade guides in order, reducing confusion and errors.
src/pages/resources/upgrade/upgrade-holochain-0.3.md (1)
7-8: Consistent upgrade guide sequencing.Follows the same pattern as the 0.5 upgrade guide to ensure users complete prerequisite upgrades first.
src/pages/resources/upgrade/upgrade-holochain-0.6.md (4)
19-48: Verify TODO tag is still needed or can be resolved.Line 19 has a TODO comment "get the right tag name" but the diff already shows
main-0.6in the holonix URL. If this tag is correct for the 0.6 release, the TODO can be resolved. If the tag name should be different (e.g.,main-0.6.0or similar), update it from the holonix repository.
236-246: Approve:delete_linkAPI change clearly documented.The requirement for
GetOptionsis clearly explained with motivation and a concise before/after example.
247-304: Approve: Manifest and AppInfo changes are well-documented.The manifest format changes (version '0',
bundled→path) and theAppStatusunion structure are clearly explained with comprehensive code examples showing all status variants and their handling.
192-192: Note: docs.rs link forget_links_detailswill be invalid until HDK 0.6 is published.This is a known blocker per the PR comments. The link on line 192 references
docs.rs/hdk/latest/hdk/link/fn.get_links_details.html, which will not resolve until the HDK 0.6 release is available on docs.rs. This is expected and mentioned in the PR as a reason not to merge until ready to adopt 0.6.
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
src/pages/resources/upgrade/upgrade-holochain-0.6.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
src/pages/resources/upgrade/upgrade-holochain-0.6.md
[style] ~8-~8: The word ‘biggest’ tends to be overused. Consider an alternative.
Context: ... guide to get you upgraded to 0.6. The biggest change in Holochain 0.6 is that warrants a...
(BIG_DIFFERENCE)
[style] ~196-~196: ‘exact same’ might be wordy. Consider a shorter alternative.
Context: ...ith count_links, so you can apply the exact same query predicates with ease. ```diff:ru...
(EN_WORDINESS_PREMIUM_EXACT_SAME)
🪛 markdownlint-cli2 (0.18.1)
src/pages/resources/upgrade/upgrade-holochain-0.6.md
117-117: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
129-129: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
139-139: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
157-157: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
174-174: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
184-184: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
198-198: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
242-242: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
253-253: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
261-261: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
272-272: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
🔇 Additional comments (3)
src/pages/resources/upgrade/upgrade-holochain-0.6.md (3)
1-11: Frontmatter and intro are clear. ✅The frontmatter correctly titles this as a 0.5→0.6 upgrade guide, and the intro properly explains the scope (warrants now stable) and references the 0.4→0.5 guide for earlier migrations.
19-19: Verify or resolve the TODO about tag name.Line 19 has a TODO comment about "get the right tag name" for the Nix flake update. Verify the
main-0.6tag name is correct before merging, or update the comment if the tag naming has been confirmed.
188-304: API and manifest documentation is comprehensive and well-structured. ✅The sections documenting API changes (LinkQuery consolidation, get_links_details rename, delete_link signature, AppInfo status struct) are clear with helpful code examples. The manifest format changes are well-illustrated with diffs.
There was a problem hiding this comment.
looks good -- i'm going to try upgrading an app as well to help check it.
I caught a few breaking changes in the changelog that relate to apps. Not sure if they need to be mentioned:
-
Renamed
happ_manifestfield of a web app bundle tohapp. The field is expected to point to a.happfile, not ahapp.yaml. The name change reflects that. -
BREAKING CHANGE PR #5129: Removed
hashfunction from host functions. Use thehash_actionandhash_entryfunctions fromHDIinstead. -
BREAKING CHANGE: Host function
callreturns a specific error when calling another cell by cell ID that cannot be found.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
src/pages/resources/upgrade/upgrade-holochain-0.6.md (2)
6-8: Minor wording suggestion: consider alternatives to "biggest change."LanguageTool flags "biggest" as potentially overused. For a technical upgrade guide, phrasing like "The most significant change" or "A major change" could convey the same meaning more precisely.
190-196: Minor wording suggestion: simplify "exact same."Line 196 uses "exact same query predicates" which LanguageTool flags as potentially redundant. Consider "the same query predicates" or "identical query predicates" for conciseness. Note: The link to
get_links_detailson these lines currently points to docs.rs/hdk/latest, which will become valid once Holochain 0.6 is published to docs.rs (known blocker per PR objectives).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
src/pages/build/cryptography-functions.md(0 hunks)src/pages/resources/upgrade/upgrade-holochain-0.6.md(1 hunks)
💤 Files with no reviewable changes (1)
- src/pages/build/cryptography-functions.md
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-09-11T13:19:23.020Z
Learnt from: pdaoust
PR: holochain/docs-pages#597
File: src/pages/resources/glossary.md:933-939
Timestamp: 2025-09-11T13:19:23.020Z
Learning: In the holochain/docs-pages repository, pdaoust prefers glossary definitions to be "future-correct" rather than strictly reflecting current implementation status, to reduce maintenance burden when features are implemented.
Applied to files:
src/pages/resources/upgrade/upgrade-holochain-0.6.md
🪛 LanguageTool
src/pages/resources/upgrade/upgrade-holochain-0.6.md
[style] ~8-~8: The word ‘biggest’ tends to be overused. Consider an alternative.
Context: ... guide to get you upgraded to 0.6. The biggest change in Holochain 0.6 is that warrants a...
(BIG_DIFFERENCE)
[style] ~196-~196: ‘exact same’ might be wordy. Consider a shorter alternative.
Context: ...ith count_links, so you can apply the exact same query predicates with ease. ```diff:ru...
(EN_WORDINESS_PREMIUM_EXACT_SAME)
🪛 markdownlint-cli2 (0.18.1)
src/pages/resources/upgrade/upgrade-holochain-0.6.md
117-117: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
129-129: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
139-139: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
157-157: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
174-174: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
184-184: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
198-198: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
242-242: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
257-257: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
265-265: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
288-288: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
302-302: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
🔇 Additional comments (3)
src/pages/resources/upgrade/upgrade-holochain-0.6.md (3)
113-125: Version placeholders acknowledged.The TODO comment and placeholder versions (hdk 0.6.0, hdi 0.7.0) are intentional per prior review discussions. The guidance directing readers to crates.io (line 125) provides a good safety mechanism for readers. As noted in PR objectives, exact version numbers should be updated before merge once releases are official.
153-180: JavaScript version placeholders acknowledged.The TODO markers and placeholder versions (@holochain/client 0.20.0-0.20.1, @holochain/tryorama 0.19.0) are intentional per prior review discussions. Per PR objectives, these should be updated to actual stable versions before merge once npm releases occur.
Minor note: The version difference between test (0.20.0) and UI (0.20.1) packages appears intentional.
298-334: AppInfo breaking change well-documented.The TypeScript code example clearly shows the migration from AppInfoStatus to the new AppStatus union with its nested type discriminators. The structure is appropriate for a breaking change guide, and the exhaustive pattern matching helps users understand all the new cases they need to handle.
|
I could continue reviewing content but the formatting in the first section makes it effectively unreadable. I'm pausing for now. 
|
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
src/pages/resources/upgrade/upgrade-holochain-0.6.md (2)
5-11: Intro section is clear, but consider tightening language on line 8.Fenced code blocks with language identifiers are preferred for readability and syntax highlighting. The intro section is well-structured. However, LanguageTool suggests "biggest" tends to be overused—consider alternatives like "primary" or "main" for line 8 ("The primary change in Holochain 0.6 is...").
184-230: API changes are well-documented with clear examples, but consider simplifying language on line 192.The Rust API refactoring examples are comprehensive and easy to follow. The consolidation of link-querying APIs using
LinkQueryandGetStrategyis well-explained. However, LanguageTool flags line 192's "exact same" as potentially wordy—consider "identical" or simply "the same" for conciseness.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
src/pages/resources/upgrade/upgrade-holochain-0.6.md(1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-09-11T13:19:23.020Z
Learnt from: pdaoust
PR: holochain/docs-pages#597
File: src/pages/resources/glossary.md:933-939
Timestamp: 2025-09-11T13:19:23.020Z
Learning: In the holochain/docs-pages repository, pdaoust prefers glossary definitions to be "future-correct" rather than strictly reflecting current implementation status, to reduce maintenance burden when features are implemented.
Applied to files:
src/pages/resources/upgrade/upgrade-holochain-0.6.md
🪛 LanguageTool
src/pages/resources/upgrade/upgrade-holochain-0.6.md
[style] ~8-~8: The word ‘biggest’ tends to be overused. Consider an alternative.
Context: ... guide to get you upgraded to 0.6. The biggest change in Holochain 0.6 is that warrants a...
(BIG_DIFFERENCE)
[style] ~192-~192: ‘exact same’ might be wordy. Consider a shorter alternative.
Context: ...ith count_links, so you can apply the exact same query predicates with ease. ```diff:ru...
(EN_WORDINESS_PREMIUM_EXACT_SAME)
🔇 Additional comments (8)
src/pages/resources/upgrade/upgrade-holochain-0.6.md (8)
17-52: Verify the Nix flake diff block renders correctly (ThetaSinner flagged rendering issue).Blank lines before and after fenced code blocks improve readability in raw Markdown. ThetaSinner reported that the first diff block (lines 19–46) isn't rendering correctly and provided a screenshot showing formatting problems. Before merging, please verify that this diff block renders as intended on the docs site. If issues persist, consider:
- Adding a blank line before the opening fence (line 18)
- Checking for trailing whitespace or encoding issues
- Testing on the actual docs platform (Netlify/docs-pages render)
53-89: Package dependency updates and build script changes look correct.The modifications to
package.jsonare sound: nodejs version bump, hc-spin update, and RUSTFLAGS addition for getrandom_backend configuration are all appropriate for the 0.6 upgrade path. The diff is clearly structured and easy to follow.
105-140: Rust dependency update instructions are clear; version placeholders are intentional.The section correctly documents the Cargo.toml changes and includes appropriate guidance on running
cargo buildand optionalcargo update. The TODO comment on line 111 correctly flags that version numbers need final confirmation before merge, which aligns with the PR objective to update exact versions once stable releases are available.
156-176: Verify @holochain/client version consistency between test and UI packages.Lines 156–159 show
@holochain/client: ^0.20.0for tests, but lines 172–173 show@holochain/client: ^0.20.1for the UI package. This version mismatch could lead to subtle inconsistencies between test and production environments. Either:
- Align both to the same semver range (both
^0.20.0or both^0.20.1), or- Add an inline comment explaining why the UI requires a higher patch version.
232-241: Delete link API change is well-documented.The addition of
GetOptionsparameter todelete_linkis clearly explained with reasoning and context. The TODO comment about potentially usingGetStrategyis appropriately marked for future consideration.
242-245: Hashing functions removal is clearly documented.The explanation of which functions were removed (
hash_blake2b,hash_keccak256, etc.) and which remain (hash_action,hash_entry) is clear. Guidance to move hashing to the client side is appropriate.
294-330: AppInfo response struct changes are well-documented with comprehensive TypeScript examples.The transition from
AppInfoStatusto the newAppStatusunion type is clearly explained. The code example effectively demonstrates the new nested discriminated union pattern for thedisabledstatus type, making it easy for developers to update their code.
332-336: Subtle changes section appropriately documents the Holo WebSDK removal.A concise note about the removal of the Holo WebSDK from the scaffolding tool. This is a helpful heads-up for developers who may have used it in previous versions.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
src/pages/resources/upgrade/upgrade-holochain-0.6.md (2)
19-46: Standardize code fence syntax for consistent rendering across diff blocks.The first diff block (lines 19–46) uses the bare
difflanguage tag, while subsequent blocks use compound tags likediff:json,diff:toml, anddiff:rust. This inconsistency, combined with ThetaSinner's report of formatting issues in this section, suggests the renderer may not recognize thedifftag correctly.Audit all code fences and either:
- Use consistent
diffsyntax across all blocks (if supported), or- Use language-specific syntax throughout (
diff:json,diff:toml, etc.) for maximum compatibilityIf the documentation site uses a custom code block syntax (e.g., Astro/Docusaurus directives), verify that the fence syntax matches its specifications.
Proposed change for line 19 (if using consistent
diff:nixformat):- ```diff + ```diff:nix {Similarly, verify lines 55, 113, 153, and 194 are also using consistent syntax. If the site prefers just
diffwithout a language specifier, ensure all fences use that format.Also applies to: 55-55, 113-113, 153-153, 194-194
8-8: Minor style improvements to reduce wordiness (optional).Two words/phrases are flagged as overused or wordy by style checkers:
- Line 8: "The biggest change" → consider "The most significant change" or "The primary change"
- Line 192: "apply the exact same query predicates" → consider "apply the same query predicates"
These are stylistic refinements and not required, but they improve conciseness.
Also applies to: 192-192
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
src/pages/resources/upgrade/upgrade-holochain-0.6.md(1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-09-11T13:19:23.020Z
Learnt from: pdaoust
PR: holochain/docs-pages#597
File: src/pages/resources/glossary.md:933-939
Timestamp: 2025-09-11T13:19:23.020Z
Learning: In the holochain/docs-pages repository, pdaoust prefers glossary definitions to be "future-correct" rather than strictly reflecting current implementation status, to reduce maintenance burden when features are implemented.
Applied to files:
src/pages/resources/upgrade/upgrade-holochain-0.6.md
🪛 LanguageTool
src/pages/resources/upgrade/upgrade-holochain-0.6.md
[style] ~8-~8: The word ‘biggest’ tends to be overused. Consider an alternative.
Context: ... guide to get you upgraded to 0.6. The biggest change in Holochain 0.6 is that warrants a...
(BIG_DIFFERENCE)
[style] ~192-~192: ‘exact same’ might be wordy. Consider a shorter alternative.
Context: ...ith count_links, so you can apply the exact same query predicates with ease. ```diff:ru...
(EN_WORDINESS_PREMIUM_EXACT_SAME)
🔇 Additional comments (2)
src/pages/resources/upgrade/upgrade-holochain-0.6.md (2)
1-336: Verify coverage of all issue #608 requirements; consider adding conductor/protocol/schema incompatibility notes.Issue #608 requests documentation of:
- ✓ Breaking API features in HDI/HDK (covered in lines 186–244)
- ✗ Breaking API features in conductor APIs (not covered)
- ✓ Breaking API features in JavaScript client (covered in lines 294–330)
- ✗ Network protocol incompatibilities (not covered)
- ✗ Database schema incompatibilities (not covered)
The guide focuses on changes developers must make to hApp code and dependencies, which is valuable. However, if conductor API changes, network protocol breaks, or database schema migrations are relevant for the target audience (even if "just for awareness"), consider adding brief sections or links to external documentation.
If these are intentionally out of scope (e.g., covered in separate ops/infrastructure guides), this is acceptable. Please clarify the intent.
282-292: Manifest field rename diff is correctly oriented.The diff on lines 289–291 correctly shows
happ_manifest(old) being replaced withhapp(new), matching the explanatory text on line 282. The direction is correct, and the nested YAML structure is accurate.
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
11ty-extensions/eleventy-transforms.js (1)
58-58: UsestartsWithfor improved readability.The substring comparison is correct but could be more idiomatic.
Apply this diff:
- if (maybeLanguage[0].substring(0, 4) == 'diff') { + if (maybeLanguage[0].startsWith('diff')) {
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
11ty-extensions/eleventy-transforms.js(1 hunks)
🔇 Additional comments (1)
11ty-extensions/eleventy-transforms.js (1)
81-103: Well-structured refactoring of diff handling logic.The conditional logic cleanly handles both plain diffs and diffs with target languages (e.g.,
language-diff:javascript). The implementation correctly:
- Extracts the target language using an appropriate regex pattern
- Applies language-specific highlighting when a target exists
- Falls back to plain diff rendering when no target is specified
- Consistently applies the
hljsclass to both code blocks
pdaoust
force-pushed
the
feat/upgrade-guide-0.6
branch
from
f234616 to
e0ab17b
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
11ty-extensions/eleventy-transforms.js(1 hunks)src/pages/_data/navigation/mainNav.json5(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- src/pages/_data/navigation/mainNav.json5
🔇 Additional comments (1)
11ty-extensions/eleventy-transforms.js (1)
79-101: Well-structured conditional handling for languaged and unlanguaged diffs.The refactored logic cleanly separates the handling of diffs with target languages (e.g., "language-diff:rust") from plain diffs ("language-diff"). The implementation correctly:
- Extracts the optional target language using a precise regex
- Applies appropriate syntax highlighting to both the original diff and the applied code
- Uses
textContentfor plain text insertion (prevents XSS)- Ensures the
hljsclass is added in all code paths for consistent styling
|
The other upgrade guides seem to have disappeared |
pdaoust
force-pushed
the
feat/upgrade-guide-0.6
branch
from
a700ef7 to
7f10d70
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
netlify.toml (1)
48-59: TightentodoPatternsbefore merge (and avoid duplicate entries).The temporary
get_links_detailsdocs.rs entry plus the “remove before merging this PR” comment are a good way to keep CI green while 0.6 docs are not yet live, but please actually drop that pattern (and likely re-enable strict checking on that URL) once docs.rs is updated. Also,https://ubuntu.comappears twice intodoPatterns; removing one of them will keep the list cleaner without changing behavior.Based on learnings, this stays compatible with the custom
netlify-plugin-checklinksbehavior.
🧹 Nitpick comments (5)
11ty-extensions/eleventy-transforms.js (1)
118-125: Consider adding early exit after diff branch completes.After
pre.replaceWith(tabContainer)at line 118, thecodevariable references an orphaned node. Line 125 then addshljsto this orphaned node, which has no effect on the output (lines 100-101 already handled it before serialization).Adding
continueafter line 118 would make the control flow clearer and skip the redundant operation:// Now replace the original code block with the diff+applied version. pre.replaceWith(tabContainer); + continue; } else {src/pages/build/happs.md (1)
85-85: Minor formatting issue: unordered list indentation. The bullet point has 8 spaces of indentation; the linter expects 4. Please adjust for consistency.* `dna`: The DNA that fills the role. - * `path`: The filesystem location of the DNA bundle at package build time; the [packager](#package-a-happ-for-distribution) will bundle this file into the package. + * `path`: The filesystem location of the DNA bundle at package build time; the [packager](#package-a-happ-for-distribution) will bundle this file into the package.src/pages/build/dnas.md (1)
71-71: Minor formatting issue: unordered list indentation. The bullet point has 8 spaces of indentation; the linter expects 4.* `hash`: Optional. If the hash of the zome at the specified location doesn't match this value, installation will fail. - * `path`: The filesystem location of the zome at package build time; the [packager](#bundle-a-dna) will bundle this file into the package. + * `path`: The filesystem location of the zome at package build time; the [packager](#bundle-a-dna) will bundle this file into the package.src/pages/build/links-paths-and-anchors.md (1)
104-105: Style suggestion: simplify phrasing. The phrase "In order to validate a link deletion action" could be more concise.-!!! info Specifying a get strategy -In order to validate a link deletion action, the original link creation action has to be available locally +!!! info Specifying a get strategy +To validate a link deletion action, the original link creation action must be available locallysrc/pages/resources/upgrade/upgrade-holochain-0.6.md (1)
345-366: Consider showing holochain_serialized_bytes as a new dependency.Per matthme's comment, the
holochain_serialized_bytesdependency on line 362 appears to be new as of 0.6. Consider showing this as an added line in the diff to make it clear this is a new requirement:[dependencies] hdk = { workspace = true } serde = { workspace = true } +holochain_serialized_bytes = { workspace = true } posts_integrity = { workspace = true } -rand = "0.8" +rand = "0.9"This would help developers understand they need to add this dependency when upgrading.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (32)
.cspell/custom-words.txt(2 hunks)11ty-extensions/eleventy-transforms.js(1 hunks)netlify.toml(2 hunks)src/pages/_data/navigation/footerLinks.json5(1 hunks)src/pages/_data/navigation/mainNav.json5(2 hunks)src/pages/build/capabilities.md(3 hunks)src/pages/build/connecting-a-front-end.md(1 hunks)src/pages/build/cryptography-functions.md(0 hunks)src/pages/build/dnas.md(3 hunks)src/pages/build/genesis-self-check-callback.md(0 hunks)src/pages/build/happs.md(6 hunks)src/pages/build/identifiers.md(1 hunks)src/pages/build/links-paths-and-anchors.md(7 hunks)src/pages/build/must-get-host-functions.md(1 hunks)src/pages/build/signals.md(1 hunks)src/pages/build/zomes.md(3 hunks)src/pages/get-started/2-hello-world.md(1 hunks)src/pages/get-started/3-forum-app-tutorial.md(2 hunks)src/pages/get-started/index.md(2 hunks)src/pages/get-started/install-advanced.md(3 hunks)src/pages/resources/compatibility/holochain-0.5.md(1 hunks)src/pages/resources/compatibility/holochain-0.6.md(1 hunks)src/pages/resources/compatibility/index.md(2 hunks)src/pages/resources/howtos/debugging.md(1 hunks)src/pages/resources/howtos/running-network-infrastructure.md(3 hunks)src/pages/resources/index.md(1 hunks)src/pages/resources/upgrade/index.md(1 hunks)src/pages/resources/upgrade/upgrade-holochain-0.3.md(1 hunks)src/pages/resources/upgrade/upgrade-holochain-0.4.md(1 hunks)src/pages/resources/upgrade/upgrade-holochain-0.5.md(1 hunks)src/pages/resources/upgrade/upgrade-holochain-0.6.md(1 hunks)src/pages/resources/upgrade/upgrade-new-holonix.md(1 hunks)
💤 Files with no reviewable changes (2)
- src/pages/build/cryptography-functions.md
- src/pages/build/genesis-self-check-callback.md
✅ Files skipped from review due to trivial changes (2)
- src/pages/resources/upgrade/upgrade-new-holonix.md
- src/pages/get-started/3-forum-app-tutorial.md
🚧 Files skipped from review as they are similar to previous changes (6)
- src/pages/build/must-get-host-functions.md
- src/pages/resources/howtos/debugging.md
- src/pages/resources/upgrade/upgrade-holochain-0.4.md
- src/pages/resources/upgrade/upgrade-holochain-0.5.md
- src/pages/resources/howtos/running-network-infrastructure.md
- src/pages/build/capabilities.md
🧰 Additional context used
🧠 Learnings (10)
📓 Common learnings
Learnt from: pdaoust
Repo: holochain/docs-pages PR: 600
File: netlify.toml:0-0
Timestamp: 2025-09-04T20:49:15.819Z
Learning: The holochain/docs-pages repository uses a custom fork of netlify-plugin-checklinks (github:pdaoust/netlify-plugin-checklinks) that supports skipRegexPatterns with regex patterns delimited by backticks, unlike the upstream plugin.
Learnt from: pdaoust
Repo: holochain/docs-pages PR: 607
File: src/pages/resources/glossary.md:312-315
Timestamp: 2025-09-19T17:48:55.462Z
Learning: In the holochain/docs-pages repository, pdaoust's slugification code automatically converts camelCase/PascalCase words to hyphenated format (e.g., "DeepKey" becomes "deep-key"), so explicit anchors are not needed for such headings.
Learnt from: pdaoust
Repo: holochain/docs-pages PR: 597
File: src/pages/resources/glossary.md:933-939
Timestamp: 2025-09-11T13:19:23.020Z
Learning: In the holochain/docs-pages repository, pdaoust prefers glossary definitions to be "future-correct" rather than strictly reflecting current implementation status, to reduce maintenance burden when features are implemented.
Learnt from: pdaoust
Repo: holochain/docs-pages PR: 594
File: src/pages/resources/howtos/running-network-infrastructure.md:178-185
Timestamp: 2025-07-31T17:05:08.265Z
Learning: pdaoust prefers to ignore the MD047 rule (files should end with a single newline character) in the holochain/docs-pages repository because it's not applicable to the admonition plugin they're using.
📚 Learning: 2025-08-28T23:39:06.675Z
Learnt from: pdaoust
Repo: holochain/docs-pages PR: 600
File: src/pages/get-started/install-advanced.md:74-81
Timestamp: 2025-08-28T23:39:06.675Z
Learning: hc-launch may show older Holochain version dependencies (like "holochain 0.5.3") even when other tools show newer versions (like 0.5.5) because hc-launch is only repackaged when necessary for compatibility, not automatically with every Holochain release.
Applied to files:
src/pages/resources/compatibility/holochain-0.6.mdsrc/pages/get-started/index.mdsrc/pages/resources/upgrade/upgrade-holochain-0.3.mdsrc/pages/get-started/install-advanced.mdnetlify.tomlsrc/pages/resources/compatibility/holochain-0.5.mdsrc/pages/resources/upgrade/index.mdsrc/pages/get-started/2-hello-world.mdsrc/pages/resources/upgrade/upgrade-holochain-0.6.mdsrc/pages/build/identifiers.mdsrc/pages/resources/compatibility/index.md
📚 Learning: 2025-09-11T13:19:23.020Z
Learnt from: pdaoust
Repo: holochain/docs-pages PR: 597
File: src/pages/resources/glossary.md:933-939
Timestamp: 2025-09-11T13:19:23.020Z
Learning: In the holochain/docs-pages repository, pdaoust prefers glossary definitions to be "future-correct" rather than strictly reflecting current implementation status, to reduce maintenance burden when features are implemented.
Applied to files:
src/pages/resources/compatibility/holochain-0.6.mdsrc/pages/resources/upgrade/upgrade-holochain-0.6.mdsrc/pages/resources/compatibility/index.md
📚 Learning: 2025-09-04T20:49:15.819Z
Learnt from: pdaoust
Repo: holochain/docs-pages PR: 600
File: netlify.toml:0-0
Timestamp: 2025-09-04T20:49:15.819Z
Learning: The holochain/docs-pages repository uses a custom fork of netlify-plugin-checklinks (github:pdaoust/netlify-plugin-checklinks) that supports skipRegexPatterns with regex patterns delimited by backticks, unlike the upstream plugin.
Applied to files:
src/pages/_data/navigation/footerLinks.json5netlify.tomlsrc/pages/resources/upgrade/upgrade-holochain-0.6.md
📚 Learning: 2025-09-04T20:50:12.871Z
Learnt from: pdaoust
Repo: holochain/docs-pages PR: 600
File: netlify.toml:3-3
Timestamp: 2025-09-04T20:50:12.871Z
Learning: In netlify.toml, using absolute paths like `/node_modules/netlify-plugin-checklinks` is valid and works correctly in Netlify builds when pointing to custom plugin installations, ensuring the custom fork is used instead of any official plugin that Netlify might resolve by package name.
Applied to files:
netlify.toml
📚 Learning: 2025-09-18T21:17:38.306Z
Learnt from: pdaoust
Repo: holochain/docs-pages PR: 607
File: src/pages/build/entries.md:342-345
Timestamp: 2025-09-18T21:17:38.306Z
Learning: In Holochain, `hdk::entry::get` filters out invalid record data and returns None for invalid or missing records, while `get_details` returns records regardless of validation status with metadata indicating their validation state. The `must_get*` functions operate in a different context (validation) and don't relate cleanly to the `get*` functions.
Applied to files:
src/pages/build/links-paths-and-anchors.md
📚 Learning: 2025-09-19T17:48:55.462Z
Learnt from: pdaoust
Repo: holochain/docs-pages PR: 607
File: src/pages/resources/glossary.md:312-315
Timestamp: 2025-09-19T17:48:55.462Z
Learning: In the holochain/docs-pages repository, pdaoust's slugification code automatically converts camelCase/PascalCase words to hyphenated format (e.g., "DeepKey" becomes "deep-key"), so explicit anchors are not needed for such headings.
Applied to files:
src/pages/resources/upgrade/upgrade-holochain-0.6.md
📚 Learning: 2025-07-31T17:04:48.450Z
Learnt from: pdaoust
Repo: holochain/docs-pages PR: 594
File: src/pages/resources/howtos/running-network-infrastructure.md:5-7
Timestamp: 2025-07-31T17:04:48.450Z
Learning: In the holochain/docs-pages repository, pdaoust prefers "howto" (unhyphenated) over "how-to" (hyphenated) as it's the established pattern used consistently throughout the codebase for section titles, navigation, and documentation references.
Applied to files:
src/pages/resources/upgrade/upgrade-holochain-0.6.md
📚 Learning: 2025-07-31T17:05:08.265Z
Learnt from: pdaoust
Repo: holochain/docs-pages PR: 594
File: src/pages/resources/howtos/running-network-infrastructure.md:178-185
Timestamp: 2025-07-31T17:05:08.265Z
Learning: pdaoust prefers to ignore the MD047 rule (files should end with a single newline character) in the holochain/docs-pages repository because it's not applicable to the admonition plugin they're using.
Applied to files:
src/pages/resources/upgrade/upgrade-holochain-0.6.md
📚 Learning: 2025-09-08T21:51:44.027Z
Learnt from: pdaoust
Repo: holochain/docs-pages PR: 597
File: src/pages/build/getting-an-agents-status.md:141-141
Timestamp: 2025-09-08T21:51:44.027Z
Learning: In the holochain_zome_types::query::AgentActivity struct, the correct field name is `valid_activity`, not `valid_actions`. This field contains the valid activities for an agent according to the official Rust documentation.
Applied to files:
src/pages/resources/upgrade/upgrade-holochain-0.6.md
🪛 LanguageTool
src/pages/resources/compatibility/holochain-0.6.md
[style] ~8-~8: Using many exclamation marks might seem excessive (in this case: 6 exclamation marks for a text that’s 3956 characters long)
Context: ...recommended* version for general use. !!! For more information on versioning and...
(EN_EXCESSIVE_EXCLAMATION)
src/pages/build/links-paths-and-anchors.md
[style] ~104-~104: Consider a more concise word here.
Context: ...``` !!! info Specifying a get strategy In order to validate a link deletion action, the or...
(IN_ORDER_TO_PREMIUM)
src/pages/resources/compatibility/holochain-0.5.md
[style] ~6-~6: Using many exclamation marks might seem excessive (in this case: 6 exclamation marks for a text that’s 4085 characters long)
Context: ...esources/compatibility/holochain-0.6/). !!! For more information on versioning and...
(EN_EXCESSIVE_EXCLAMATION)
src/pages/resources/upgrade/upgrade-holochain-0.6.md
[style] ~8-~8: The word ‘biggest’ tends to be overused. Consider an alternative.
Context: ... guide to get you upgraded to 0.6. The biggest change in Holochain 0.6 is that warrants a...
(BIG_DIFFERENCE)
[style] ~176-~176: ‘exact same’ might be wordy. Consider a shorter alternative.
Context: ...ith count_links, so you can apply the exact same query predicates with ease. ```diff:ru...
(EN_WORDINESS_PREMIUM_EXACT_SAME)
[grammar] ~435-~435: Ensure spelling is correct
Context: ...yorama tests and web app Now that your zome and client code have both been updated,...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🪛 markdownlint-cli2 (0.18.1)
src/pages/build/dnas.md
71-71: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
src/pages/build/happs.md
85-85: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: cog-status-check
- GitHub Check: Redirect rules - developer-portal-production
- GitHub Check: Header rules - developer-portal-production
- GitHub Check: Pages changed - developer-portal-production
🔇 Additional comments (41)
.cspell/custom-words.txt (1)
20-20: LGTM!The three additions (dylib, getrandom, rlib) are all legitimate technical terms related to Rust/Holochain development. They're correctly alphabetically ordered and appropriate for inclusion in the spellcheck custom words list.
Also applies to: 24-24, 57-57
src/pages/build/connecting-a-front-end.md (1)
27-27: Update Rust client library link to main branch for 0.6 release.The link now points to the stable
mainbranch, aligning with the Holochain 0.6 release. This is consistent with the PR objectives.Given the PR context mentions build failures due to broken documentation links that won't exist until 0.6 is published, please verify that this URL is accessible and points to the correct resource. You can check it by visiting the link directly:
https://github.com/holochain/holochain/tree/main/crates/clientAlso, if there are other similar branch or version references in this file or related front-end documentation, ensure they're consistently updated for 0.6.
src/pages/build/signals.md (1)
89-100: Update toHashSetis correct for Holochain 0.6.The change from
BTreeSettoHashSetcorrectly reflects the Holochain 0.6 API update toGrantedFunctions::Listed. The example code remains valid and idiomatic.Please verify that the upgrade guide (or related docs) explicitly documents this
GrantedFunctions::ListedAPI change so readers understand why the example has changed. This will help with clarity for users migrating from 0.5 to 0.6.11ty-extensions/eleventy-transforms.js (3)
58-58: Improved diff language detection looks good.The word boundary anchor
/^diff\b/correctly matchesdiffanddiff:languagewhile excluding false positives likediffstatordifference. This addresses the previous feedback.
79-98: Conditional diff highlighting logic is well structured.The branching correctly handles:
- Languaged diffs (
diff:rust) → highlights both blocks with proper languages, transforms class name- Unlanguaged diffs (
diff) → plain text for final, diff highlighting for originalMinor edge case: if someone writes
```diff:(with trailing colon but no language), the regex at line 80 won't match, and line 95's replace would leave a stray:in the class. This is unlikely in practice since it would be a malformed language hint.
100-101: Correctly addshljsclass to both code blocks before serialization.Both elements now receive the highlighting class before
outerHTMLis called at lines 113-114, ensuring CSS styles targeting.hljsapply correctly. This addresses the previous feedback.src/pages/get-started/2-hello-world.md (1)
21-21: Version reference updated correctly. The scaffolding tool reference has been updated to the 0.6 branch in alignment with the broader upgrade rollout.src/pages/get-started/index.md (2)
76-76: Holochain development environment reference updated to 0.6. The Nix invocation correctly points to the main-0.6 branch, consistent with the framework upgrade.
110-110: Scaffolding CLI version updated to 0.600.0. The displayed version reflects the 0.6 release cycle, consistent with the Nix reference update on line 76.src/pages/build/identifiers.md (1)
168-170: Workspace dependencies correctly updated for Holochain 0.6. HDI and HDK versions have been bumped to 0.7.0 and 0.6.0 respectively, withholo_hashadded to support external hash construction as documented in the section.Please verify that these pinned versions (HDI=0.7.0, HDK=0.6.0, holo_hash=0.6.0) are the exact versions that will be released as part of Holochain 0.6. The PR description mentions the build is currently failing due to unavailable docs.rs links, which suggests version numbers may still need finalization.
src/pages/get-started/install-advanced.md (3)
29-29: Ad-hoc Holonix shell example updated to main-0.6. This reflects the current development branch for Holochain 0.6.
44-46: Version descriptions updated correctly. The documentation accurately reflects the release branches:mainor no ref for development (0.6),main-0.5for current recommended, andmain-0.4for previous maintenance releases.
74-96: Build info output updated to reflect Holochain 0.6.0. All component versions have been bumped consistently: holochain_scaffolding_cli, hc-launch, lair_keystore, and Rust toolchain versions are all aligned with the 0.6 release cycle.Please confirm that the rustc version (1.88.0) and lair_keystore version (0.6.3) are confirmed for the final 0.6 release. The PR description notes that exact version numbers still need updating before merge.
src/pages/build/zomes.md (3)
73-74: Added [lib] section with correct crate type. Thecrate-type = ["cdylib"]is necessary for compiling Rust zomes to WebAssembly, and this addition ensures the scaffolding examples are complete.
77-77: HDI dependency bumped to 0.7.0. Version is consistent with the upgrade documentation and Holochain 0.6 requirements.Confirm this version is final before merge, as per the PR guidance about pending version number updates.
103-108: Coordinator zome Cargo.toml updated with HDK 0.6.0 and path dependency. The HDK version bump and addition of the path-based integrity zome dependency are correct and follow standard Rust workspace patterns for monorepo builds.src/pages/build/happs.md (4)
20-20: Scaffolding reference updated to main-0.6. The hc-scaffold command reference is correctly updated to align with the 0.6 release cycle.
40-40:⚠️ Verify manifest_version downgrade from '1' to '0'. The hApp manifest version has been changed from '1' to '0', which appears to be a downgrade. Please confirm this is intentional and represents a valid version scheme change in Holochain 0.6, rather than an error. The upgrade documentation should clarify this breaking change for users.
49-60: DNA location syntax updated to path-based format. The manifests now specifypath: ./dnas/<name>/<name>.dnainstead of bundled locations. Documentation has been updated to clarify that paths are filesystem locations resolved at package build time.
108-113: Web hApp manifest updated to manifest_version '0' and path-based locations. Consistent with the hApp manifest changes, web hApp manifests now use version '0' and path-based references for UI and happ_manifest files.Please confirm that manifest_version '0' is the correct version scheme for Holochain 0.6 web hApp manifests (consistent with the hApp change on line 40).
src/pages/build/dnas.md (2)
42-42: DNA manifest_version updated to '0'. This is consistent with the manifest_version change in the hApp documentation and represents the Holochain 0.6 manifest format version.This manifest_version downgrade to '0' should be documented in the upgrade guide. Please ensure users understand this is a breaking change requiring manifest updates when upgrading from 0.5 to 0.6.
52-57: Zome paths updated to filesystem-based format. Both integrity and coordinator zome locations now use explicit path references (zomes/*/target/wasm32-unknown-unknown/release/*.wasm) instead of bundled format. This aligns with the path-based DNA structure change.src/pages/build/links-paths-and-anchors.md (5)
99-106: delete_link API updated with GetOptions parameter. The function now requires a second parameter specifying the retrieval strategy (GetOptions::network()orGetOptions::local()), with documentation explaining when each should be used. This is a breaking API change requiring developer attention in the upgrade guide.Confirm that the guidance on GetOptions selection (local for locally-available data, network otherwise) correctly reflects the validation semantics in Holochain 0.6. This is critical for proper link deletion behavior.
127-151: get_links API comprehensively updated to LinkQuery + GetStrategy pattern. The function signature has changed fromget_links(base)toget_links(LinkQuery::try_new(base, link_type)?, GetStrategy::default()). All examples, including tag filtering, have been correctly updated to use the new builder-style LinkQuery API.These are breaking API changes. Please verify that:
LinkQuery::try_new()is the correct constructor in HDK 0.6.0GetStrategy::default()is the appropriate default strategy- All example code patterns are consistent with the final HDK 0.6 API surface
The PR notes that the build is failing due to unavailable docs.rs links for get_links_details, suggesting documentation publication is pending.
154-163: get_links_details examples updated to match get_links API. The function has been renamed fromget_link_detailsand updated to accept the same LinkQuery and GetStrategy parameters. All examples reflect the new pattern consistently.Confirm that
get_links_details(plural) is the correct function name in HDK 0.6.0 and is available at the docs.rs link. The PR mentions build failures due to unavailable documentation for this function.
168-168: count_links documentation updated with network behavior note. The documentation correctly notes thatcount_linkscurrently lacks configurable get strategy and always goes to the network, which is an important caveat for performance-conscious developers.
251-286: Path retrieval examples updated to LinkQuery + GetStrategy pattern. Allget_linkscalls within path-based collection examples have been updated to use the new LinkQuery and GetStrategy API, maintaining consistency throughout the code samples.src/pages/resources/upgrade/upgrade-holochain-0.3.md (1)
5-9: Good clarity on multi-step upgrade path.The new sentence clearly directs 0.1 users through the 0.2 guide first; link target matches the existing 0.2 guide path and keeps the upgrade story consistent.
src/pages/_data/navigation/footerLinks.json5 (1)
16-24: Footer client links now point to concrete references.Updating the JS client to the docs file and the Rust client to docs.rs makes the footer much more directly useful; this also aligns with the main Resources page links.
src/pages/resources/index.md (1)
54-60: Conductor JS client link now targets the actual docs.Pointing the “Conductor Client reference (JavaScript)” link at
docs/client.mdmatches the footer and gives readers a direct path to the reference material.src/pages/resources/upgrade/index.md (1)
13-18: Upgrade list ordering looks good for 0.6.Putting the 0.5 → 0.6 guide first and keeping the Holonix guide clearly marked as “all versions” makes the list easy to scan for current vs legacy paths.
src/pages/resources/compatibility/holochain-0.5.md (1)
5-7: Clear legacy positioning for 0.5 and better table labeling.Marking 0.5 as maintenance-only and directing readers to the 0.6 table, plus renaming the header to “Latest compatible version”, makes this page’s status and purpose very explicit while keeping the version matrix readable.
Also applies to: 13-29
src/pages/resources/compatibility/index.md (1)
9-10: Compatibility overview now correctly centers 0.6 and documents versioning rules.Listing 0.6 first as the recommended release and spelling out the
hdi, tooling (×100), and client/version-series relationships makes this page a solid entry point for understanding how the detailed 0.5/0.6 tables fit together.Also applies to: 20-22
netlify.toml (1)
190-202: Redirecting “latest” to 0.6 aligns the site with the new recommended release.Both
/resources/upgrade/latest/and/resources/compatibility/latest/now land on the 0.6 docs, which matches the 0.6 “recommended” status elsewhere in the site.src/pages/resources/compatibility/holochain-0.6.md (1)
1-31: 0.6 compatibility table is well-structured and consistent with the 0.5 page.The “Recommended” banner plus the detailed component/“Latest compatible version” matrix give a clear, centralized source of truth for the 0.6 stack, and the TODO about flipping this to legacy when 0.7 arrives is a sensible maintenance note.
src/pages/resources/upgrade/upgrade-holochain-0.6.md (4)
1-103: Comprehensive quick-start instructions.The quick instructions section provides a clear, step-by-step upgrade path. The Nix flake updates, package.json changes (including the important RUSTFLAGS addition for getrandom_backend), and testing steps are well-documented and logical.
Note: The TODO comments at lines 17 and 53 are acknowledged by the author as intentional placeholders to be resolved before merge.
105-166: Clear dependency update instructions.The dependency update section is well-structured, covering both Rust (HDK/HDI) and JavaScript (@holochain/client, @holochain/tryorama) dependencies with appropriate version progressions. The cargo update and npm install steps are clearly documented.
The TODO comments at lines 111 and 137 are tracked for pre-merge resolution.
168-446: Excellent API change documentation.The application code update section is comprehensive and well-structured, covering all major breaking changes:
- Link API changes (get_links_details rename, query consolidation, delete_link GetOptions)
- ChainFilter bounds changes with clear migration examples
- Manifest format updates for all types (DNA, hApp, web hApp)
- AppInfo response struct changes with detailed TypeScript example
- GrantedFunctions::Listed type change (BTreeSet → HashSet)
The before/after code examples are particularly helpful for developers performing the upgrade.
447-494: Well-documented optional changes.The optional conductor config section appropriately scopes itself to Kangaroo-based projects and provides a comprehensive diff showing DPKI removal and other configuration updates. The subtle changes section usefully flags non-breaking changes (Holo WebSDK removal) that may affect developers' expectations.
src/pages/_data/navigation/mainNav.json5 (2)
68-74: Navigation structure appropriately updated for 0.6 release.The navigation changes correctly:
- Add Holochain 0.6 to the Compatibility Tables
- Restructure Upgrade Guides as a nested section under Resources (improving hierarchy)
- Add the new "Holochain 0.5 → 0.6" upgrade guide entry
The TODO comments on lines 68 and 72 are helpful reminders for future maintenance to keep the most recent guides visible in the navigation.
83-84: Client documentation links updated to more specific paths.The external client links have been improved to point to more specific documentation:
- JavaScript client now points to the docs/client.md in the repo
- Rust client now points to the docs.rs documentation page
These provide better direct access to API documentation for developers.
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
netlify.toml(2 hunks)
🧰 Additional context used
🧠 Learnings (4)
📓 Common learnings
Learnt from: pdaoust
Repo: holochain/docs-pages PR: 600
File: netlify.toml:0-0
Timestamp: 2025-09-04T20:49:15.819Z
Learning: The holochain/docs-pages repository uses a custom fork of netlify-plugin-checklinks (github:pdaoust/netlify-plugin-checklinks) that supports skipRegexPatterns with regex patterns delimited by backticks, unlike the upstream plugin.
Learnt from: pdaoust
Repo: holochain/docs-pages PR: 607
File: src/pages/resources/glossary.md:312-315
Timestamp: 2025-09-19T17:48:55.462Z
Learning: In the holochain/docs-pages repository, pdaoust's slugification code automatically converts camelCase/PascalCase words to hyphenated format (e.g., "DeepKey" becomes "deep-key"), so explicit anchors are not needed for such headings.
Learnt from: pdaoust
Repo: holochain/docs-pages PR: 597
File: src/pages/resources/glossary.md:933-939
Timestamp: 2025-09-11T13:19:23.020Z
Learning: In the holochain/docs-pages repository, pdaoust prefers glossary definitions to be "future-correct" rather than strictly reflecting current implementation status, to reduce maintenance burden when features are implemented.
📚 Learning: 2025-09-04T20:49:15.819Z
Learnt from: pdaoust
Repo: holochain/docs-pages PR: 600
File: netlify.toml:0-0
Timestamp: 2025-09-04T20:49:15.819Z
Learning: The holochain/docs-pages repository uses a custom fork of netlify-plugin-checklinks (github:pdaoust/netlify-plugin-checklinks) that supports skipRegexPatterns with regex patterns delimited by backticks, unlike the upstream plugin.
Applied to files:
netlify.toml
📚 Learning: 2025-09-04T20:50:12.871Z
Learnt from: pdaoust
Repo: holochain/docs-pages PR: 600
File: netlify.toml:3-3
Timestamp: 2025-09-04T20:50:12.871Z
Learning: In netlify.toml, using absolute paths like `/node_modules/netlify-plugin-checklinks` is valid and works correctly in Netlify builds when pointing to custom plugin installations, ensuring the custom fork is used instead of any official plugin that Netlify might resolve by package name.
Applied to files:
netlify.toml
📚 Learning: 2025-08-28T23:39:06.675Z
Learnt from: pdaoust
Repo: holochain/docs-pages PR: 600
File: src/pages/get-started/install-advanced.md:74-81
Timestamp: 2025-08-28T23:39:06.675Z
Learning: hc-launch may show older Holochain version dependencies (like "holochain 0.5.3") even when other tools show newer versions (like 0.5.5) because hc-launch is only repackaged when necessary for compatibility, not automatically with every Holochain release.
Applied to files:
netlify.toml
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Redirect rules - developer-portal-production
- GitHub Check: Header rules - developer-portal-production
- GitHub Check: Pages changed - developer-portal-production
🔇 Additional comments (1)
netlify.toml (1)
198-199: Updated redirects for upgrade and compatibility latest versions are correct.The redirect paths from
/resources/upgrade/latest/and/resources/compatibility/latest/have been correctly updated to point to the new 0.6 versions. Verify that the target pages (e.g.,/resources/upgrade/upgrade-holochain-0.6/and/resources/compatibility/holochain-0.6/) exist in the codebase and are properly created by the accompanying changes in this PR.Also applies to: 203-204
| "https://ubuntu.com", | ||
| # TODO: remove this before merging this PR | ||
| "https://docs.rs/hdk/latest/hdk/link/fn.get_links_details.html", | ||
| # Sometimes ubuntu.com still times out, even with the concurrency dialed down. | ||
| "https://ubuntu.com", |
There was a problem hiding this comment.
Consolidate duplicate https://ubuntu.com entry in todoPatterns.
The same URL appears twice in the todoPatterns list (lines 54 and 58), with different preceding comments. Deduplicate by removing one occurrence—likely line 54 (which is grouped under an NPM comment)—and keep line 58 with its more specific comment about timeouts.
todoPatterns = [
# Don't know why these don't appear, and maybe they should.
"_site/pagefind",
# NPM now blocks bots.
# https://github.com/orgs/community/discussions/174098#discussioncomment-14461226
"https://www.npmjs.com",
- "https://ubuntu.com",
# TODO: remove this before merging this PR
"https://docs.rs/hdk/latest/hdk/link/fn.get_links_details.html",
# Sometimes ubuntu.com still times out, even with the concurrency dialed down.
"https://ubuntu.com",
]📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| "https://ubuntu.com", | |
| # TODO: remove this before merging this PR | |
| "https://docs.rs/hdk/latest/hdk/link/fn.get_links_details.html", | |
| # Sometimes ubuntu.com still times out, even with the concurrency dialed down. | |
| "https://ubuntu.com", | |
| # TODO: remove this before merging this PR | |
| "https://docs.rs/hdk/latest/hdk/link/fn.get_links_details.html", | |
| # Sometimes ubuntu.com still times out, even with the concurrency dialed down. | |
| "https://ubuntu.com", |
🤖 Prompt for AI Agents
In netlify.toml around lines 54 to 58, there is a duplicate "https://ubuntu.com"
entry in the todoPatterns array; remove the earlier occurrence (line 54, the one
grouped under the NPM comment) so only the later entry with the timeout-related
comment (line 58) remains, and ensure the surrounding list commas/formatting
remain valid after deletion.
7d321b4 to
f78f1b8
Compare
|
✔️ 82af0ca...f78f1b8 - Conventional commits check succeeded. |
ThetaSinner
dismissed
zippy’s stale review
review submitted against an older version of this PR
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
netlify.toml (1)
54-54: Consolidate duplicatehttps://ubuntu.comentry.Lines 54 and 58 both contain
https://ubuntu.com. As flagged in the prior review, remove the earlier occurrence (line 54, grouped under the NPM comment) and retain line 58 with its specific timeout-related rationale.todoPatterns = [ # Don't know why these don't appear, and maybe they should. "_site/pagefind", # NPM now blocks bots. # https://github.com/orgs/community/discussions/174098#discussioncomment-14461226 "https://www.npmjs.com", - "https://ubuntu.com", # TODO: remove this before merging this PR "https://docs.rs/hdk/latest/hdk/link/fn.get_links_details.html", # Sometimes ubuntu.com still times out, even with the concurrency dialed down. "https://ubuntu.com", # Suddenly Medium is sending 403 errors to scrapers. "https://medium.com", ]Also applies to: 58-58
🧹 Nitpick comments (1)
netlify.toml (1)
195-199: Update stale TODO comment.Line 195 states
TODO(upgrade): change following version number, but the version has already been updated to 0.6 on line 198. Update the comment to reflect the current state, or remove it if no further action is needed.# Every time there's a new breaking release that achieves 'recommended' status, # update this temporary redirect. /resources/upgrade/latest/ isn't in the site nav, # but it is a handy URL we can hand out without needing to look up what the proper URL is. -# TODO(upgrade): change following version number [[redirects]] from = "/resources/upgrade/latest/" to = "/resources/upgrade/upgrade-holochain-0.6/" status = 302
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
netlify.toml(2 hunks)
🧰 Additional context used
🧠 Learnings (3)
📓 Common learnings
Learnt from: pdaoust
Repo: holochain/docs-pages PR: 600
File: netlify.toml:0-0
Timestamp: 2025-09-04T20:49:15.819Z
Learning: The holochain/docs-pages repository uses a custom fork of netlify-plugin-checklinks (github:pdaoust/netlify-plugin-checklinks) that supports skipRegexPatterns with regex patterns delimited by backticks, unlike the upstream plugin.
Learnt from: pdaoust
Repo: holochain/docs-pages PR: 607
File: src/pages/resources/glossary.md:312-315
Timestamp: 2025-09-19T17:48:55.462Z
Learning: In the holochain/docs-pages repository, pdaoust's slugification code automatically converts camelCase/PascalCase words to hyphenated format (e.g., "DeepKey" becomes "deep-key"), so explicit anchors are not needed for such headings.
Learnt from: pdaoust
Repo: holochain/docs-pages PR: 594
File: src/pages/resources/howtos/running-network-infrastructure.md:178-185
Timestamp: 2025-07-31T17:05:08.265Z
Learning: pdaoust prefers to ignore the MD047 rule (files should end with a single newline character) in the holochain/docs-pages repository because it's not applicable to the admonition plugin they're using.
📚 Learning: 2025-09-04T20:49:15.819Z
Learnt from: pdaoust
Repo: holochain/docs-pages PR: 600
File: netlify.toml:0-0
Timestamp: 2025-09-04T20:49:15.819Z
Learning: The holochain/docs-pages repository uses a custom fork of netlify-plugin-checklinks (github:pdaoust/netlify-plugin-checklinks) that supports skipRegexPatterns with regex patterns delimited by backticks, unlike the upstream plugin.
Applied to files:
netlify.toml
📚 Learning: 2025-08-28T23:39:06.675Z
Learnt from: pdaoust
Repo: holochain/docs-pages PR: 600
File: src/pages/get-started/install-advanced.md:74-81
Timestamp: 2025-08-28T23:39:06.675Z
Learning: hc-launch may show older Holochain version dependencies (like "holochain 0.5.3") even when other tools show newer versions (like 0.5.5) because hc-launch is only repackaged when necessary for compatibility, not automatically with every Holochain release.
Applied to files:
netlify.toml
🔇 Additional comments (2)
netlify.toml (2)
55-56: Temporary entry acknowledged.The
get_links_detailsURL is marked for removal before merge, consistent with your note that the build currently fails pending hdk 0.6 publication to docs.rs. Ensure this entry is removed once the version is finalized and 0.6 is published.
196-204: Upgrade and compatibility redirects correctly updated to 0.6.The
latestredirects now point to the new 0.6 upgrade and compatibility pages, properly establishing 0.6 as the current supported version.
Closes #608
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.