Skip to content

chore(#3875): add Updating your product developer docs page#3920

Open
Spark450 wants to merge 6 commits into
devfrom
mark/updating-your-product-docs
Open

chore(#3875): add Updating your product developer docs page#3920
Spark450 wants to merge 6 commits into
devfrom
mark/updating-your-product-docs

Conversation

@Spark450
Copy link
Copy Markdown
Collaborator

@Spark450 Spark450 commented May 7, 2026

Summary

  • Adds new page at Get started > Developers > Updating your product
  • Wires the page into the Developers nav group after "Setup"
  • Incorporates content from the attached file in #3875 and a condensed version of the migration walkthrough from the design guild session (#3864)

Changes

  • docs/src/pages/get-started/developers/updating-your-product.astro — new page
  • docs/src/components/nav/GetStartedSubMenu.tsx — nav entry added after "Setup"

Content notes

  • The inline drop-in callout from the content file is replaced with the shared <DropInCallout /> component
  • "Setup" in Step 2 is hyperlinked to /get-started/developers/setup
  • Migration walkthrough section added between "Why we recommend updating all at once" and Step 1, linking to https://bdfranck.github.io/ds2-upgrade-walkthrough/#public-form

Test plan

  • Navigate to Get started > Developers in the docs site — "Updating your product" appears after "Setup" in the nav
  • Page loads at /get-started/developers/updating-your-product
  • All sections render correctly and the table of contents reflects the headings
  • "Setup" link in Step 2 navigates to the setup page
  • "Explore the migration walkthrough" link opens correctly in a new tab
  • Drop-in hours callout appears at the bottom of the page

Fixes #3875

🤖 Generated with Claude Code

@Spark450 @claude
chore(#3875): add Updating your product developer docs page
f9c73c4 
Fixes #3875

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@Spark450 Spark450 linked an issue May 7, 2026 that may be closed by this pull request
Docs: Create new page — Updating your product (developers) #3875
Open
2 tasks
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 7, 2026 •
edited
Loading

PR Preview Action v1.8.1

QR code for preview link

🚀 View preview at
https://GovAlta.github.io/ui-components/pr-preview-angular/pr-3920/

Built to branch gh-pages at 2026-05-11 21:52 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 7, 2026 •
edited
Loading

Preview links

Target URL
Docs https://govalta.github.io/ui-components/pr-preview/pr-3920/
React playground https://govalta.github.io/ui-components/pr-preview-react/pr-3920/
Angular playground https://govalta.github.io/ui-components/pr-preview-angular/pr-3920/

Built from commit 15e15b1. Previews are removed automatically when this PR closes.

Spark450 and others added 3 commits May 7, 2026 11:55
@Spark450 @claude
chore(#3875): replace goa-text body with p tags, use heading-m for h2s
a58d62c 
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@Spark450 @claude
chore(#3875): group steps under Migration steps heading, use h3 for s…
42ce683 
…tep headings

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@Spark450 @claude
chore(#3875): fix writing guide violations — passive voice, direction…
98a14d5 
…al refs, filler phrases

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@Spark450 Spark450 marked this pull request as ready for review May 7, 2026 20:50
@Spark450 Spark450 self-assigned this May 7, 2026
@ArakTaiRoth ArakTaiRoth mentioned this pull request May 8, 2026
Open
5 tasks
willcodeforcoffee
willcodeforcoffee reviewed May 8, 2026
View reviewed changes
Comment thread docs/src/pages/get-started/developers/updating-your-product.astro Outdated
</p>
<goa-link version="2" size="medium">
<a
href="https://bdfranck.github.io/ds2-upgrade-walkthrough/#public-form"
Copy link
Copy Markdown
Collaborator

@willcodeforcoffee willcodeforcoffee May 8, 2026

Choose a reason for hiding this comment

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

Is this the correct URL? We probably shouldn't use something linked to Benji's account?!

@twjeffery
Merge origin/dev into mark/updating-your-product-docs
2ef2aeb 
Resolves conflict in GetStartedSubMenu.tsx by adopting dev's
content-collection-driven nav (the static PAGE_GROUPS array was
removed in #3906). The page itself still needs to be migrated from
docs/src/pages/.../updating-your-product.astro to an MDX entry in
the content collection; that follows in the next commit.
twjeffery
twjeffery reviewed May 11, 2026
View reviewed changes
Copy link
Copy Markdown
Collaborator

@twjeffery twjeffery left a comment

Choose a reason for hiding this comment

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

@Spark450 I updated the get started pages in #3906 right before your PR, so the page needs to move into the new shape. I'll add a follow up commit to this branch with the changes needed for you to review.

Changes:

  1. Move it into the content collection like the other developer pages
  2. Fix the Setup link in Step 2 with withBase(), it's 404'ing in the preview.

I also added two content changes while I was in there, happy to revert either:
3. Changed the wording of "branch review" to "Review the updated application".
4. Turned "What to look for" and "Understanding the effort" into tables to better outline that content.

If you're happy with it, we can squash it all together.

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

Reviewers

@willcodeforcoffee willcodeforcoffee willcodeforcoffee left review comments

@twjeffery twjeffery twjeffery left review comments

At least 2 approving reviews are required to merge this pull request.

Assignees

@Spark450 Spark450

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Docs: Create new page — Updating your product (developers)

3 participants

@Spark450 @willcodeforcoffee @twjeffery