Skip to content

chore: remove hello-world step from getting started tutorial#644

Open
pdaoust wants to merge 4 commits into
mainfrom
chore/remove-hello-world-tutorial
Open

chore: remove hello-world step from getting started tutorial#644
pdaoust wants to merge 4 commits into
mainfrom
chore/remove-hello-world-tutorial

Conversation

@pdaoust

@pdaoust pdaoust commented May 28, 2026

Copy link
Copy Markdown
Contributor

NOTE: this PR is ready to go, but we won't deploy it until Holochain 0.7 is the recommended version, because the changes to the scaffolding tool won't apply until then.

Things I did:

  • remove the hello world page (step 2) from the tutorial
  • removed its image assets
  • renamed steps 3 (forum) and 4 (packaging) to 2 and 3 respectively
  • renamed image assets for step 3
  • updated menu entries
  • copied still-useful content from the hello world page onto the forum page
  • added 301 redirects to the new forum and packaging page URLs

Closes #631

@coderabbitai

coderabbitai Bot commented May 28, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 0652b9b3-ff14-46cf-8ae9-47b3f59d3911

📥 Commits

Reviewing files that changed from the base of the PR and between 80a318a and 244da7f.

⛔ Files ignored due to path filters (6)
  • src/assets/img/get-started/2-look-for-hellos.png is excluded by !**/*.png
  • src/assets/img/get-started/2-two-uis.png is excluded by !**/*.png
  • src/assets/img/get-started/3-no-posts-found.png is excluded by !**/*.png
  • src/assets/img/get-started/4-create-post-component.png is excluded by !**/*.png
  • src/assets/img/get-started/5-edit-post.png is excluded by !**/*.png
  • src/assets/img/get-started/6-comment-components.png is excluded by !**/*.png
📒 Files selected for processing (15)
  • netlify.toml
  • src/pages/_data/navigation/mainNav.json5
  • src/pages/build/application-structure.md
  • src/pages/build/connecting-a-front-end.md
  • src/pages/build/dht-operations.md
  • src/pages/build/happs.md
  • src/pages/build/validate-callback.md
  • src/pages/build/validation.md
  • src/pages/build/zomes.md
  • src/pages/get-started/2-forum-app-tutorial.md
  • src/pages/get-started/2-hello-world.md
  • src/pages/get-started/3-packaging-and-distribution.md
  • src/pages/get-started/index.md
  • src/pages/resources/compatibility/index.md
  • src/pages/resources/upgrade/upgrade-holochain-0.5.md
💤 Files with no reviewable changes (1)
  • src/pages/get-started/2-hello-world.md
✅ Files skipped from review due to trivial changes (10)
  • src/pages/build/application-structure.md
  • src/pages/build/connecting-a-front-end.md
  • src/pages/build/zomes.md
  • src/pages/build/validate-callback.md
  • src/pages/build/happs.md
  • src/pages/resources/upgrade/upgrade-holochain-0.5.md
  • src/pages/build/validation.md
  • src/pages/build/dht-operations.md
  • netlify.toml
  • src/pages/_data/navigation/mainNav.json5

Walkthrough

This PR removes the Hello World tutorial, promotes the Forum App tutorial as the primary Get Started path, updates navigation and Netlify routing/checklinks configuration, expands and revises the Forum App tutorial with working directory setup, project layout explanation, AppArmor-based Ubuntu 24.04 dev-mode fix, updated screenshots, and adjusted button markup, and updates internal cross-reference links across build, resource, and upgrade documentation to the renumbered tutorial paths.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly describes the main change: removing the hello-world step from the getting started tutorial, which aligns with the primary objective of the PR.
Description check ✅ Passed The description is directly related to the changeset, detailing the specific actions taken including removal of the hello world page, renumbering of steps, and addition of redirects.
Linked Issues check ✅ Passed The PR fulfills both objectives from issue #631: it deletes the hello-world page and moves directory layout explanation content from hello-world to the forum app tutorial page.
Out of Scope Changes check ✅ Passed All changes are in scope: documentation updates for renumbered steps, navigation configuration, redirect rules, and removal of the hello-world tutorial step as specified in issue #631.
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
  • Commit unit tests in branch chore/remove-hello-world-tutorial

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@netlify.toml`:
- Around line 103-111: The two redirect blocks currently map each path to itself
(/get-started/2-forum-app-tutorial/ and
/get-started/3-packaging-and-distribution/); update the redirects so the from
fields are the legacy/old URLs you intend to replace and the to fields point to
the new destination pages (or delete these redundant blocks if no redirect is
needed), e.g., modify the [[redirects]] entries referencing
"/get-started/2-forum-app-tutorial/" and
"/get-started/3-packaging-and-distribution/" so they do not have identical from
and to values.

In `@src/pages/get-started/2-forum-app-tutorial.md`:
- Line 853: Replace the non-descriptive link text "[here]" in the sentence "You
can find out more
[here](/get-started/install-advanced/#fixing-the-suid-sandbox-error-in-ubuntu-24-04-and-later)."
with a descriptive phrase such as "in the advanced install guide section on
fixing the SUID sandbox error" so the link reads: "You can find out more in the
advanced install guide section on fixing the SUID sandbox error." This change
should be made where that sentence appears in the get-started tutorial content
(the line containing the existing [here] link).
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: a46553f3-c0f6-47d9-b781-627d94d8128f

📥 Commits

Reviewing files that changed from the base of the PR and between dcfeeb4 and 33a7509.

⛔ Files ignored due to path filters (6)
  • src/assets/img/get-started/2-look-for-hellos.png is excluded by !**/*.png
  • src/assets/img/get-started/2-two-uis.png is excluded by !**/*.png
  • src/assets/img/get-started/3-no-posts-found.png is excluded by !**/*.png
  • src/assets/img/get-started/4-create-post-component.png is excluded by !**/*.png
  • src/assets/img/get-started/5-edit-post.png is excluded by !**/*.png
  • src/assets/img/get-started/6-comment-components.png is excluded by !**/*.png
📒 Files selected for processing (15)
  • netlify.toml
  • src/pages/_data/navigation/mainNav.json5
  • src/pages/build/application-structure.md
  • src/pages/build/connecting-a-front-end.md
  • src/pages/build/dht-operations.md
  • src/pages/build/happs.md
  • src/pages/build/validate-callback.md
  • src/pages/build/validation.md
  • src/pages/build/zomes.md
  • src/pages/get-started/2-forum-app-tutorial.md
  • src/pages/get-started/2-hello-world.md
  • src/pages/get-started/3-packaging-and-distribution.md
  • src/pages/get-started/index.md
  • src/pages/resources/compatibility/index.md
  • src/pages/resources/upgrade/upgrade-holochain-0.5.md
💤 Files with no reviewable changes (1)
  • src/pages/get-started/2-hello-world.md

Comment thread netlify.toml
Comment thread src/pages/get-started/2-forum-app-tutorial.md
@coderabbitai

coderabbitai Bot commented May 28, 2026

Copy link
Copy Markdown

Actionable comments posted: 0

@jost-s jost-s left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks great! Just one change requested regarding the UI framework selection.

Comment thread src/pages/get-started/2-forum-app-tutorial.md Outdated
@pdaoust pdaoust requested a review from a team May 28, 2026 19:09
@github-project-automation github-project-automation Bot moved this to Backlog in Holochain May 29, 2026
@pdaoust pdaoust moved this from Backlog to In Review in Holochain May 29, 2026
@ThetaSinner ThetaSinner requested a review from jost-s June 23, 2026 07:41
@jost-s jost-s force-pushed the chore/remove-hello-world-tutorial branch from 80a318a to 244da7f Compare June 23, 2026 11:13
@cocogitto-bot

cocogitto-bot Bot commented Jun 23, 2026

Copy link
Copy Markdown

✔️ a938e57...244da7f - Conventional commits check succeeded.

@jost-s

jost-s commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

NOTE: this PR is ready to go, but we won't deploy it until Holochain 0.7 is the recommended version, because the changes to the scaffolding tool won't apply until then.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: In Review

Development

Successfully merging this pull request may close these issues.

Update app tutorial after removing hello-world example app

3 participants