Skip to content

Conversation

@AlexSkrypnyk
Copy link
Member

@AlexSkrypnyk AlexSkrypnyk commented Sep 8, 2025

This is a part 1 of #1999
In part 2, we will add the updated checklist back to the docs based on the adjusted onboarding documentation.

Summary by CodeRabbit

  • Documentation

    • Removed the Onboarding checklist and all related references across docs and READMEs, simplifying the getting-started and features content.
  • Chores

    • Removed the installer prompt for preserving the onboarding checklist to streamline the setup flow.
  • Tests

    • Updated tests and test helpers to remove onboarding-related cases and assertions, aligning test coverage with the documentation and installer changes.

@coderabbitai
Copy link

coderabbitai bot commented Sep 8, 2025

Walkthrough

Removes the onboarding checklist feature: deletes docs/onboarding.md and its DOCS_ONBOARDING markers, removes the PreserveDocsOnboarding installer handler and its wiring in PromptManager, and updates tests, BATS helpers, CLAUDE token listing, and documentation references. No runtime behavior beyond prompt/docs removal was added.

Changes

Cohort / File(s) Summary
Installer prompt removal
.vortex/installer/src/Prompts/Handlers/PreserveDocsOnboarding.php, .vortex/installer/src/Prompts/PromptManager.php
Deletes the PreserveDocsOnboarding handler file and removes its import, registration, processing ID, prompt wiring, and responses-summary entry from PromptManager.
Docs and README cleanup
.vortex/docs/content/getting-started/architecture.mdx, .vortex/docs/content/getting-started/features.mdx, README.dist.md, docs/README.md, docs/onboarding.md
Removes onboarding checklist text/links and deletes docs/onboarding.md; strips DOCS_ONBOARDING anchors and related onboarding content from README files.
CLAUDE token list update
.vortex/CLAUDE.md
Removes the DOCS_ONBOARDING/documentation entry and related token/documentation lines from the CLAUDE token listing.
Tests updates (PHPUnit)
.vortex/installer/tests/Functional/Handlers/BaselineInstallTest.php, .vortex/installer/tests/Functional/Handlers/DocsInstallTest.php, .vortex/installer/tests/Unit/Handlers/AbstractPromptManagerTestCase.php, .vortex/installer/tests/Unit/Handlers/DocsPromptManagerTest.php
Removes imports, #[CoversClass] annotations, data-provider cases, and expected/default entries related to PreserveDocsOnboarding; retains other prompt tests.
BATS helper cleanup
.vortex/tests/bats/_helper.bash
Removes onboarding assertion helper functions (assert_files_present_onboarding, assert_files_present_no_onboarding).

Sequence Diagram(s)

sequenceDiagram
  autonumber
  participant User as User
  participant PM as PromptManager
  participant PProj as PreserveDocsProject
  rect rgba(200,230,255,0.3)
    Note over PM: Onboarding prompt removed from flow
  end
  User->>PM: Run installer (docs prompts)
  PM->>PProj: Ask "Preserve project docs?"
  PProj-->>PM: Response (yes/no)
  PM->>PM: Process project-doc response (tokens/files)
  PM-->>User: Summary (no onboarding entry)
Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

Poem

I nibbled the checklist, page by page,
Hopped past prompts — retired with age.
Docs trimmed light, carrots gleam,
Installer hops a leaner dream.
Thump-thump — onward we bound, neat and spry. 🥕🐇


📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9a134c2 and 236c3a5.

⛔ Files ignored due to path filters (16)
  • .vortex/installer/tests/Fixtures/install/_baseline/README.md is excluded by !.vortex/installer/tests/Fixtures/**
  • .vortex/installer/tests/Fixtures/install/_baseline/docs/README.md is excluded by !.vortex/installer/tests/Fixtures/**
  • .vortex/installer/tests/Fixtures/install/_baseline/docs/onboarding.md is excluded by !.vortex/installer/tests/Fixtures/**
  • .vortex/installer/tests/Fixtures/install/deps_updates_provider_none/docs/onboarding.md is excluded by !.vortex/installer/tests/Fixtures/**
  • .vortex/installer/tests/Fixtures/install/hosting_acquia/README.md is excluded by !.vortex/installer/tests/Fixtures/**
  • .vortex/installer/tests/Fixtures/install/hosting_acquia/docs/onboarding.md is excluded by !.vortex/installer/tests/Fixtures/**
  • .vortex/installer/tests/Fixtures/install/hosting_lagoon/README.md is excluded by !.vortex/installer/tests/Fixtures/**
  • .vortex/installer/tests/Fixtures/install/hosting_lagoon/docs/onboarding.md is excluded by !.vortex/installer/tests/Fixtures/**
  • .vortex/installer/tests/Fixtures/install/names/README.md is excluded by !.vortex/installer/tests/Fixtures/**
  • .vortex/installer/tests/Fixtures/install/preserve_docs_onboarding_disabled/README.md is excluded by !.vortex/installer/tests/Fixtures/**
  • .vortex/installer/tests/Fixtures/install/preserve_docs_onboarding_disabled/docs/-onboarding.md is excluded by !.vortex/installer/tests/Fixtures/**
  • .vortex/installer/tests/Fixtures/install/preserve_docs_onboarding_disabled/docs/README.md is excluded by !.vortex/installer/tests/Fixtures/**
  • .vortex/installer/tests/Fixtures/install/preserve_docs_onboarding_enabled/.ignorecontent is excluded by !.vortex/installer/tests/Fixtures/**
  • .vortex/installer/tests/Fixtures/install/provision_database_lagoon/README.md is excluded by !.vortex/installer/tests/Fixtures/**
  • .vortex/installer/tests/Fixtures/install/provision_database_lagoon/docs/onboarding.md is excluded by !.vortex/installer/tests/Fixtures/**
  • .vortex/installer/tests/Fixtures/install/provision_profile/README.md is excluded by !.vortex/installer/tests/Fixtures/**
📒 Files selected for processing (13)
  • .vortex/CLAUDE.md (0 hunks)
  • .vortex/docs/content/getting-started/architecture.mdx (0 hunks)
  • .vortex/docs/content/getting-started/features.mdx (0 hunks)
  • .vortex/installer/src/Prompts/Handlers/PreserveDocsOnboarding.php (0 hunks)
  • .vortex/installer/src/Prompts/PromptManager.php (0 hunks)
  • .vortex/installer/tests/Functional/Handlers/BaselineInstallTest.php (0 hunks)
  • .vortex/installer/tests/Functional/Handlers/DocsInstallTest.php (0 hunks)
  • .vortex/installer/tests/Unit/Handlers/AbstractPromptManagerTestCase.php (0 hunks)
  • .vortex/installer/tests/Unit/Handlers/DocsPromptManagerTest.php (0 hunks)
  • .vortex/tests/bats/_helper.bash (0 hunks)
  • README.dist.md (0 hunks)
  • docs/README.md (0 hunks)
  • docs/onboarding.md (0 hunks)
💤 Files with no reviewable changes (13)
  • .vortex/docs/content/getting-started/features.mdx
  • .vortex/installer/tests/Unit/Handlers/DocsPromptManagerTest.php
  • .vortex/tests/bats/_helper.bash
  • .vortex/docs/content/getting-started/architecture.mdx
  • docs/README.md
  • docs/onboarding.md
  • .vortex/installer/src/Prompts/Handlers/PreserveDocsOnboarding.php
  • README.dist.md
  • .vortex/installer/src/Prompts/PromptManager.php
  • .vortex/installer/tests/Unit/Handlers/AbstractPromptManagerTestCase.php
  • .vortex/installer/tests/Functional/Handlers/BaselineInstallTest.php
  • .vortex/CLAUDE.md
  • .vortex/installer/tests/Functional/Handlers/DocsInstallTest.php
⏰ 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). (14)
  • GitHub Check: build (1)
  • GitHub Check: build (0)
  • GitHub Check: vortex-test-workflow (2)
  • GitHub Check: vortex-test-deployment (0)
  • GitHub Check: vortex-test-workflow (4)
  • GitHub Check: vortex-test-workflow (0)
  • GitHub Check: vortex-test-deployment (1)
  • GitHub Check: vortex-test-workflow (3)
  • GitHub Check: vortex-test-installer (8.3)
  • GitHub Check: vortex-test-installer (8.2)
  • GitHub Check: vortex-test-common
  • GitHub Check: vortex-test-workflow (1)
  • GitHub Check: vortex-test-installer (8.4)
  • GitHub Check: vortex-test-docs
✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch feature/remove-onboarding

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

@codecov
Copy link

codecov bot commented Sep 8, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 78.00%. Comparing base (ff43eb6) to head (236c3a5).
⚠️ Report is 1 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #2000      +/-   ##
===========================================
+ Coverage    77.85%   78.00%   +0.14%     
===========================================
  Files           90       89       -1     
  Lines         5555     5529      -26     
  Branches        44       44              
===========================================
- Hits          4325     4313      -12     
+ Misses        1230     1216      -14     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@AlexSkrypnyk AlexSkrypnyk force-pushed the feature/remove-onboarding branch from 9a134c2 to 236c3a5 Compare September 8, 2025 01:19
@AlexSkrypnyk AlexSkrypnyk moved this from BACKLOG to In progress in Vortex Sep 8, 2025
@AlexSkrypnyk AlexSkrypnyk added this to the 25.9.0 milestone Sep 8, 2025
@AlexSkrypnyk AlexSkrypnyk added the AUTOMERGE Pull request has been approved and set to automerge label Sep 8, 2025
@github-actions github-actions bot temporarily deployed to commit September 8, 2025 01:21 Inactive
@AlexSkrypnyk AlexSkrypnyk merged commit e4d98d4 into develop Sep 8, 2025
31 checks passed
@AlexSkrypnyk AlexSkrypnyk deleted the feature/remove-onboarding branch September 8, 2025 01:39
@github-project-automation github-project-automation bot moved this from In progress to Release queue in Vortex Sep 8, 2025
@coderabbitai coderabbitai bot mentioned this pull request Dec 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

AUTOMERGE Pull request has been approved and set to automerge

Projects

Status: Released in 25.10.0

Development

Successfully merging this pull request may close these issues.

2 participants