Skip to content

[#617] 📝 - Guide web onboarding and connect setup help to verified workflows - #618

Merged
efraespada merged 4 commits into
developfrom
docs/617-make-onboarding-web-first-with-a-verifiable-first-workflow-and-goal-based-documentation
Oct 20, 2026
Merged

efraespada merged 4 commits into
developfrom
docs/617-make-onboarding-web-first-with-a-verifiable-first-workflow-and-goal-based-documentation

Conversation

@efraespada

@efraespada efraespada commented Oct 20, 2026 •

Copy link
Copy Markdown
Member

Developers lacked a clear path from discovering Copilot to configuring it and proving that an installed workflow works. Web setup was secondary, entry pages overlapped, some guides required manual wiring after setup had generated it, and setup help did not expose the onboarding journey.

This change makes the existing web assistant the recommended interactive path, adds an illustrated setup tutorial and a real issue-to-PR walkthrough with observable checkpoints, and organizes guides around issues/branches, PR review, bot requests and releases/hotfixes. It retains the detailed maintenance/manual integration reference and corrects contradictory approval defaults, write authority and push-versus-PR review ownership.

Setup now offers tutorial, first-workflow and recovery links before pairing and throughout the web session, with localized navigation in four languages and a next-step reminder after current-repository Apply. CLI command help and journey output expose the same guides, and question links lead to goal-specific explanations. Links open only by user choice and preserve in-memory answers. Setup defaults, credential handling, permission decisions and workflow/deployment authority are unchanged. The shared URL registry has a narrowly checked static-only browser boundary; shipped bundles, SDDs and catalog evidence are updated together.

A documentation-consumption guide explains CLI versus Action versions, Git-ref previews, local/offline help and what each verification result actually proves. Support now points to real installed Issue Forms and safe diagnostics; source-checkout-only verification scripts are identified in runner/provider references. Route/anchor and local-image validation cover the new help destinations and screenshots.

Validation: 15 new navigation cases and existing behavior/architecture tests; web type checking with zero diagnostics; documentation, docs.page, agent-doc, workflow and specification validators; MDX compilation; package validation and isolated CLI/API/web-session smoke; generated-bundle synchronization; full mandatory pre-commit build, 677 Jest suites (10,954 passed, 35 skipped) and lint. Graphify's AST graph is updated. Read-only fixtures and public Git-ref previews were inspected visually; screenshots do not claim live GitHub installation or independent human/native/accessibility acceptance.

Known automation limitation: Copilot - Commit reports nonretryable validation.evidence-unavailable for progress because GitHub omits binary image/bundle patches. Existing progress is retained and no model percentage is invented. This progress-only diagnostic is separate from actual CI/review evidence; no ignore-rule or runtime-policy bypass is added.

Preview: Web setup, First workflow, Guides by goal, Use the documentation.

Closes #617

…nd-goal-based-documentation: guide web setup and verifiable workflows
@docs-page

docs-page Bot commented Oct 20, 2026

Copy link
Copy Markdown

To preview the documentation for this pull request, visit the following URL:

docs.page/vypdev/copilot~618

Documentation is deployed and generated using docs.page

@vypbot vypbot added size: XXL Indicates an extremely large task or issue that requires significant time and effort to complete. state:ai-processing labels Oct 20, 2026
@vypbot vypbot changed the title docs: make web setup and the first workflow easy to follow [#617] 📝 - Make onboarding web first with a verifiable first workflow and goal based documentation Oct 20, 2026
@vypbot
vypbot self-requested a review October 20, 2026 12:12
@vypbot vypbot added this to vypdev Oct 20, 2026
@vypbot vypbot moved this to In Progress in vypdev Oct 20, 2026
@vypbot
vypbot changed the base branch from develop to master October 20, 2026 12:13
@vypbot
vypbot changed the base branch from master to develop October 20, 2026 12:13
…nd-goal-based-documentation: avoid duplicate titles in rendered onboarding pages
@vypbot

vypbot commented Oct 20, 2026 •

Copy link
Copy Markdown
Contributor

Bugbot: review complete

Current status: No active findings on 87d4186.

Pull request · Verified commit · Workflow run

@vypbot

vypbot commented Oct 20, 2026 •

Copy link
Copy Markdown
Contributor

Copilot approval · Human review needed

Status: A protected workflow, policy, or trust-boundary file changed.
Completed: 1/1 observed checks succeeded; Bugbot complete.
Action required: Ask a human reviewer to decide.
Impact: No new approval is confirmed for this revision.
See checks

Technical evidence

Revision: 87d41864c0fa; base: 8ad771948196; reason: protected-path.

@codecov-commenter

codecov-commenter commented Oct 20, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.07%. Comparing base (274db40) to head (87d4186).
⚠️ Report is 1530 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #618      +/-   ##
===========================================
+ Coverage    90.94%   94.07%   +3.12%     
===========================================
  Files          135      938     +803     
  Lines         6251    30237   +23986     
  Branches      1338     8866    +7528     
===========================================
+ Hits          5685    28444   +22759     
- Misses         172      704     +532     
- Partials       394     1089     +695     
Files with missing lines Coverage Δ
src/application/contracts/setup_documentation.ts 100.00% <100.00%> (ø)
...on/policies/setup_question_documentation_policy.ts 100.00% <100.00%> (ø)
src/cli/commands/setup.ts 100.00% <100.00%> (ø)
src/cli/setup_journey_presenter.ts 100.00% <100.00%> (ø)
web/src/i18n/en.ts 100.00% <ø> (ø)
web/src/i18n/es.ts 100.00% <ø> (ø)
web/src/i18n/fr.ts 100.00% <ø> (ø)
web/src/i18n/pt.ts 100.00% <ø> (ø)

... and 997 files with indirect coverage changes

🚀 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.

…nd-goal-based-documentation: connect setup help and documentation consumption
@efraespada efraespada changed the title [#617] 📝 - Make onboarding web first with a verifiable first workflow and goal based documentation [#617] 📝 - Guide web onboarding and connect setup help to verified workflows Oct 20, 2026
…nd-goal-based-documentation: bind acceptance ledger to strengthened architecture check
@efraespada
efraespada merged commit 8604cff into develop Oct 20, 2026
12 of 13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size: XXL Indicates an extremely large task or issue that requires significant time and effort to complete. state:verified

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

📝🧑‍💻 - Make onboarding web first with a verifiable first workflow and goal based documentation

3 participants