Skip to content

docs(intro): update packages & CDN to redirect to other guides - #4286

Merged
brandyscarney merged 22 commits into
mainfrom
docs/cdn-updates
Nov 18, 2025
Merged

brandyscarney merged 22 commits into
mainfrom
docs/cdn-updates

Conversation

@brandyscarney

@brandyscarney brandyscarney commented Oct 17, 2025

Copy link
Copy Markdown
Member

Resolves #446 in combination with #4322

What is the current behavior?

The Packages & CDN guide has some information on how to get started with Angular, React and Vue but these sections are incomplete. For example, we cover how to add React to an existing app here but it is missing a lot of steps that are documented in the guide here. It doesn't make sense to have the same information in two places.

What is the new behavior?

This PR updates the Packages & CDN guide to redirect out to the Quickstart & Add to Existing guides for the packages, but keeps the CDN content in the Packages & CDN guide. React was the only framework that already had an Add to Existing guide, so this also adds Add to Existing guides for Angular & Vue and moves the content from the Packages & CDN guide to those.

Ionic Packages & CDN Guide Changes

Below is a before & after of the CDN page (right-click and open the image in a new tab to see the images larger):

Before After
production view of packages and cdn page branch view of packages and cdn page

Add to Existing Guide Changes

React

Angular

Vue

Important

The React URL has changed. I set up redirects for this and have left the deleted files in to update the JP docs before removing them in this PR: #4329

@vercel

vercel Bot commented Oct 17, 2025

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
ionic-docs Ready Ready Preview Comment Nov 18, 2025 5:10pm

Comment thread src/components/global/DocsCard/index.tsx
Comment thread src/components/global/DocsCards/cards.css
Comment thread vercel.json
#### 1. Install the Packages

```bash
npm install @ionic/vue @ionic/vue-router vue-router

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

The @ionic/vue-router and vue-router installs are here instead of under "Set up Routing" like the React guide because @ionic/vue errors without vue-router being installed and it seemed weird to only install it without also including @ionic/vue-router.

Comment thread docs/angular/add-to-existing.md
Update `src/app/app.html` to the following:

```html title="src/app/app.html"
<ion-button>Button</ion-button> <ion-datetime></ion-datetime>

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

These being on the same line was done by the docs linter.

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.

It would really be great if we can figure out how to keep them separate.

Comment thread docs/react/add-to-existing.md
Comment thread docs/vue/add-to-existing.md
Comment thread docs/vue/add-to-existing.md
@brandyscarney
brandyscarney marked this pull request as ready for review November 12, 2025 17:48
@brandyscarney
brandyscarney requested a review from a team as a code owner November 12, 2025 17:48
@brandyscarney
brandyscarney requested a review from gnbm November 12, 2025 17:48
Comment thread docs/intro/cdn.md
Comment thread docs/angular/add-to-existing.md

@thetaPC thetaPC 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.

My requested changes also apply to v7 when applicable.

Comment thread docs/angular/add-to-existing.md
Comment thread docs/angular/add-to-existing.md
Update `src/app/app.html` to the following:

```html title="src/app/app.html"
<ion-button>Button</ion-button> <ion-datetime></ion-datetime>

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.

It would really be great if we can figure out how to keep them separate.

Comment thread docs/intro/cdn.md
Comment thread docs/intro/cdn.md Outdated
Comment thread docs/vue/add-to-existing.md
Comment thread docs/vue/add-to-existing.md Outdated
Comment thread docs/react/add-to-existing.md Outdated
Comment thread src/components/global/DocsCard/index.tsx
Comment thread src/components/global/DocsCards/cards.css

@thetaPC thetaPC 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.

LGTM, with minor suggestions but not blockers.

Comment thread docs/angular/add-to-existing.md Outdated
Comment thread docs/react/add-to-existing.md Outdated
Comment thread docs/vue/add-to-existing.md Outdated
Comment thread versioned_docs/version-v7/react/add-to-existing.md Outdated
Comment thread docs/angular/add-to-existing.md

@thetaPC thetaPC 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.

Oops, didn't select approve. Here ya go!

@brandyscarney
brandyscarney enabled auto-merge (squash) November 18, 2025 17:09
@brandyscarney brandyscarney changed the title docs(intro): update packages & CDN to redirect to other sections docs(intro): update packages & CDN to redirect to other guides Nov 18, 2025
@brandyscarney
brandyscarney merged commit fd7dd8f into main Nov 18, 2025
0 checks passed
@brandyscarney
brandyscarney deleted the docs/cdn-updates branch November 18, 2025 17:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Use Ionic from npm without framework

3 participants