docs(readme): update broken links, repository name, clean up readme (#29508)

This commit is contained in:
Brandy Carney
2024-05-15 17:26:27 -04:00
committed by GitHub
parent ea8a5974fa
commit e826568c75
15 changed files with 39 additions and 43 deletions

View File

@ -20,7 +20,7 @@
<a href="https://github.com/ionic-team/ionic-framework/blob/main/LICENSE"> <a href="https://github.com/ionic-team/ionic-framework/blob/main/LICENSE">
<img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="Ionic Framework is released under the MIT license." /> <img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="Ionic Framework is released under the MIT license." />
</a> </a>
<a href="https://github.com/ionic-team/ionic/blob/main/docs/CONTRIBUTING.md"> <a href="https://github.com/ionic-team/ionic-framework/blob/main/docs/CONTRIBUTING.md">
<img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="PRs welcome!" /> <img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="PRs welcome!" />
</a> </a>
<a href="https://twitter.com/Ionicframework"> <a href="https://twitter.com/Ionicframework">
@ -38,7 +38,7 @@
Documentation Documentation
</a> </a>
<span> · </span> <span> · </span>
<a href="https://github.com/ionic-team/ionic/blob/main/docs/CONTRIBUTING.md">Contribute</a> <a href="https://github.com/ionic-team/ionic-framework/blob/main/docs/CONTRIBUTING.md">Contribute</a>
<span> · </span> <span> · </span>
<a href="https://blog.ionicframework.com/">Blog</a> <a href="https://blog.ionicframework.com/">Blog</a>
<br /> <br />
@ -63,14 +63,15 @@ Looking for the `ionic-angular` package? Ionic 3 has been moved to the [`ionic-v
### Getting Started ### Getting Started
Start a new project by following our quick [Getting Started guide](https://ionicframework.com/getting-started/). Start a new project by following our [documentation](https://ionicframework.com/docs/).
We would love to hear from you! If you have any feedback or run into issues using our framework, please file We would love to hear from you! If you have any feedback or run into issues using our framework, please file
an [issue](https://github.com/ionic-team/ionic/issues/new) on this repository. an [issue](https://github.com/ionic-team/ionic-framework/issues/new) on this repository.
### Migration Guides ### Migration Guides
Already have an Ionic app? These guides will help you migrate to the latest versions. Already have an Ionic app? These guides will help you migrate to the latest versions.
* [Migrate from v7 to v8](https://ionicframework.com/docs/updating/8-0)
* [Migrate from v6 to v7](https://ionicframework.com/docs/updating/7-0) * [Migrate from v6 to v7](https://ionicframework.com/docs/updating/7-0)
* [Migrate from v5 to v6](https://ionicframework.com/docs/updating/6-0) * [Migrate from v5 to v6](https://ionicframework.com/docs/updating/6-0)
* [Migrate from v4 to v5](https://ionicframework.com/docs/updating/5-0) * [Migrate from v4 to v5](https://ionicframework.com/docs/updating/5-0)
@ -82,21 +83,16 @@ The Ionic Conference App is a full featured Ionic app. It is the perfect startin
- [Angular Ionic Conference App](https://github.com/ionic-team/ionic-conference-app) - [Angular Ionic Conference App](https://github.com/ionic-team/ionic-conference-app)
- [React Ionic Conference App](https://github.com/ionic-team/ionic-react-conference-app) - [React Ionic Conference App](https://github.com/ionic-team/ionic-react-conference-app)
<!-- TODO(FW-3811): add this when the vue conference app is updated --> - [Vue Ionic Conference App](https://github.com/ionic-team/ionic-vue-conference-app)
<!-- - [Vue Ionic Conference App](https://github.com/ionic-team/ionic-vue-conference-app) -->
### Contributing ### Contributing
Thanks for your interest in contributing! Read up on our guidelines for Thanks for your interest in contributing! Read up on our guidelines for
[contributing](https://github.com/ionic-team/ionic/blob/main/docs/CONTRIBUTING.md) [contributing](https://github.com/ionic-team/ionic-framework/blob/main/docs/CONTRIBUTING.md)
and then look through our issues with a [help wanted](https://github.com/ionic-team/ionic/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) and then look through our issues with a [help wanted](https://github.com/ionic-team/ionic-framework/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22)
label. label.
Please note that this project is released with a [Contributor Code of Conduct](https://github.com/ionic-team/ionic/blob/main/CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms. Please note that this project is released with a [Contributor Code of Conduct](https://github.com/ionic-team/ionic-framework/blob/main/CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
### Future Goals
As Ionic Framework components migrate to the web component standard, a goal of ours is to have Ionic Framework easily work within all of the popular frameworks.
### Earlier Versions ### Earlier Versions

View File

@ -108,7 +108,7 @@
"url": "git+https://github.com/ionic-team/ionic-framework.git" "url": "git+https://github.com/ionic-team/ionic-framework.git"
}, },
"bugs": { "bugs": {
"url": "https://github.com/ionic-team/ionic/issues" "url": "https://github.com/ionic-team/ionic-framework/issues"
}, },
"homepage": "https://ionicframework.com/", "homepage": "https://ionicframework.com/",
"jest": { "jest": {

View File

@ -363,7 +363,7 @@ export class Searchbar implements ComponentInterface {
this.ionClear.emit(); this.ionClear.emit();
return new Promise<void>((resolve) => { return new Promise<void>((resolve) => {
// setTimeout() fixes https://github.com/ionic-team/ionic/issues/7527 // setTimeout() fixes https://github.com/ionic-team/ionic-framework/issues/7527
// wait for 4 frames // wait for 4 frames
setTimeout(() => { setTimeout(() => {
const value = this.getValue(); const value = this.getValue();

View File

@ -46,7 +46,7 @@
.toggle-icon { .toggle-icon {
// Needed to prevent visual glitch in safari/iOS // Needed to prevent visual glitch in safari/iOS
// See https://github.com/ionic-team/ionic/issues/14626 // See https://github.com/ionic-team/ionic-framework/issues/14626
transform: translate3d(0, 0, 0); transform: translate3d(0, 0, 0);
transition: background-color $toggle-ios-transition-duration; transition: background-color $toggle-ios-transition-duration;

View File

@ -213,7 +213,7 @@ export const config: Config = {
{ {
type: 'docs-vscode', type: 'docs-vscode',
file: 'dist/html.html-data.json', file: 'dist/html.html-data.json',
sourceCodeBaseUrl: 'https://github.com/ionic-team/ionic/tree/main/core/', sourceCodeBaseUrl: 'https://github.com/ionic-team/ionic-framework/tree/main/core/',
}, },
{ {
type: 'dist', type: 'dist',

View File

@ -384,9 +384,9 @@ ion-ripple-effect {
### Example Components ### Example Components
- [ion-button](https://github.com/ionic-team/ionic/tree/main/core/src/components/button) - [ion-button](https://github.com/ionic-team/ionic-framework/tree/main/core/src/components/button)
- [ion-back-button](https://github.com/ionic-team/ionic/tree/main/core/src/components/back-button) - [ion-back-button](https://github.com/ionic-team/ionic-framework/tree/main/core/src/components/back-button)
- [ion-menu-button](https://github.com/ionic-team/ionic/tree/main/core/src/components/menu-button) - [ion-menu-button](https://github.com/ionic-team/ionic-framework/tree/main/core/src/components/menu-button)
### References ### References
@ -400,7 +400,7 @@ ion-ripple-effect {
#### Example Components #### Example Components
- [ion-checkbox](https://github.com/ionic-team/ionic/tree/main/core/src/components/checkbox) - [ion-checkbox](https://github.com/ionic-team/ionic-framework/tree/main/core/src/components/checkbox)
#### VoiceOver #### VoiceOver
@ -511,7 +511,7 @@ This is a compromise we have to make in order for it to work with the other scre
#### Example Components #### Example Components
- [ion-toggle](https://github.com/ionic-team/ionic/tree/main/core/src/components/toggle) - [ion-toggle](https://github.com/ionic-team/ionic-framework/tree/main/core/src/components/toggle)
#### Voiceover #### Voiceover
@ -624,8 +624,8 @@ There is a WebKit bug open for this: https://bugs.webkit.org/show_bug.cgi?id=196
#### Example Components #### Example Components
- [ion-accordion](https://github.com/ionic-team/ionic/tree/master/core/src/components/accordion) - [ion-accordion](https://github.com/ionic-team/ionic-framework/tree/master/core/src/components/accordion)
- [ion-accordion-group](https://github.com/ionic-team/ionic/tree/master/core/src/components/accordion-group) - [ion-accordion-group](https://github.com/ionic-team/ionic-framework/tree/master/core/src/components/accordion-group)
#### NVDA #### NVDA
@ -640,11 +640,11 @@ Certain components can render an `<a>` or a `<button>` depending on the presence
### Example Components ### Example Components
- [ion-button](https://github.com/ionic-team/ionic/tree/main/core/src/components/button) - [ion-button](https://github.com/ionic-team/ionic-framework/tree/main/core/src/components/button)
- [ion-card](https://github.com/ionic-team/ionic/tree/main/core/src/components/card) - [ion-card](https://github.com/ionic-team/ionic-framework/tree/main/core/src/components/card)
- [ion-fab-button](https://github.com/ionic-team/ionic/tree/main/core/src/components/fab-button) - [ion-fab-button](https://github.com/ionic-team/ionic-framework/tree/main/core/src/components/fab-button)
- [ion-item-option](https://github.com/ionic-team/ionic/tree/main/core/src/components/item-option) - [ion-item-option](https://github.com/ionic-team/ionic-framework/tree/main/core/src/components/item-option)
- [ion-item](https://github.com/ionic-team/ionic/tree/main/core/src/components/item) - [ion-item](https://github.com/ionic-team/ionic-framework/tree/main/core/src/components/item)
### Component Structure ### Component Structure

View File

@ -17,7 +17,7 @@
"url": "git+https://github.com/ionic-team/ionic-framework.git" "url": "git+https://github.com/ionic-team/ionic-framework.git"
}, },
"bugs": { "bugs": {
"url": "https://github.com/ionic-team/ionic/issues" "url": "https://github.com/ionic-team/ionic-framework/issues"
}, },
"publishConfig": { "publishConfig": {
"directory": "dist" "directory": "dist"

View File

@ -20,7 +20,7 @@
"url": "git+https://github.com/ionic-team/ionic-framework.git" "url": "git+https://github.com/ionic-team/ionic-framework.git"
}, },
"bugs": { "bugs": {
"url": "https://github.com/ionic-team/ionic/issues" "url": "https://github.com/ionic-team/ionic-framework/issues"
}, },
"homepage": "https://ionicframework.com/", "homepage": "https://ionicframework.com/",
"scripts": { "scripts": {

View File

@ -1,7 +1,7 @@
const port = 3000; const port = 3000;
/* /*
This spec covers that routes can be added and navigated to at runtime. This spec covers that routes can be added and navigated to at runtime.
Fixes bug reported in https://github.com/ionic-team/ionic/issues/21329 Fixes bug reported in https://github.com/ionic-team/ionic-framework/issues/21329
*/ */
describe('Dynamic Routes', () => { describe('Dynamic Routes', () => {

View File

@ -3,7 +3,7 @@ const port = 3000;
describe('Dynamic Tabs', () => { describe('Dynamic Tabs', () => {
/* /*
This spec tests being able to add a tab at runtime and to be able to go to it This spec tests being able to add a tab at runtime and to be able to go to it
Fixes bug https://github.com/ionic-team/ionic/issues/21112 Fixes bug https://github.com/ionic-team/ionic-framework/issues/21112
*/ */
it('/dynamic-tabs > Tab 1 should be visible', () => { it('/dynamic-tabs > Tab 1 should be visible', () => {

View File

@ -3,7 +3,7 @@ const port = 3000;
describe('Multiple Tabs', () => { describe('Multiple Tabs', () => {
/* /*
This spec tests that switching between tabs via a menu works This spec tests that switching between tabs via a menu works
Fixes bug https://github.com/ionic-team/ionic/issues/21336 Fixes bug https://github.com/ionic-team/ionic-framework/issues/21336
*/ */
it('/multiple-tabs > PageA should be visible', () => { it('/multiple-tabs > PageA should be visible', () => {

View File

@ -6,7 +6,7 @@ describe('Nested Outlets', () => {
and to be able to transition to/from one nested outlet. and to be able to transition to/from one nested outlet.
Utilizes `ionPage` prop on `IonRouterOutlet` to make the router outlet Utilizes `ionPage` prop on `IonRouterOutlet` to make the router outlet
a target of the transition. a target of the transition.
Fixes bug https://github.com/ionic-team/ionic/issues/20597 Fixes bug https://github.com/ionic-team/ionic-framework/issues/20597
*/ */
it('/nested-outlet > First Page should be visible', () => { it('/nested-outlet > First Page should be visible', () => {
@ -59,7 +59,7 @@ describe('Nested Outlets 2', () => {
outlet is transition from and to itself, therefore it can't animate. outlet is transition from and to itself, therefore it can't animate.
I think the same issue exists when going from a item page back to the list page. I think the same issue exists when going from a item page back to the list page.
This should be fixable through configuring a less complicated route structure in the app. This should be fixable through configuring a less complicated route structure in the app.
Fixes bug https://github.com/ionic-team/ionic/issues/20219 Fixes bug https://github.com/ionic-team/ionic-framework/issues/20219
*/ */
it('/nested-outlet2 > First Page should be visible', () => { it('/nested-outlet2 > First Page should be visible', () => {

View File

@ -228,7 +228,7 @@ describe('Routing Tests', () => {
}); });
it('/ > Details 1 on settings > Back > Settings Tab, should be on setting home', () => { it('/ > Details 1 on settings > Back > Settings Tab, should be on setting home', () => {
// For bug https://github.com/ionic-team/ionic/issues/21031 // For bug https://github.com/ionic-team/ionic-framework/issues/21031
cy.visit(`http://localhost:${port}/routing/`); cy.visit(`http://localhost:${port}/routing/`);
cy.ionNav('ion-item', 'Details 1 on settings'); cy.ionNav('ion-item', 'Details 1 on settings');
cy.ionPageVisible('settings-details-page-1'); cy.ionPageVisible('settings-details-page-1');

View File

@ -40,9 +40,9 @@
"author": "", "author": "",
"license": "MIT", "license": "MIT",
"bugs": { "bugs": {
"url": "https://github.com/ionic-team/ionic/issues" "url": "https://github.com/ionic-team/ionic-framework/issues"
}, },
"homepage": "https://github.com/ionic-team/ionic#readme", "homepage": "https://github.com/ionic-team/ionic-framework#readme",
"dependencies": { "dependencies": {
"@ionic/vue": "^8.1.2" "@ionic/vue": "^8.1.2"
}, },

View File

@ -45,9 +45,9 @@
"author": "", "author": "",
"license": "MIT", "license": "MIT",
"bugs": { "bugs": {
"url": "https://github.com/ionic-team/ionic/issues" "url": "https://github.com/ionic-team/ionic-framework/issues"
}, },
"homepage": "https://github.com/ionic-team/ionic#readme", "homepage": "https://github.com/ionic-team/ionic-framework#readme",
"devDependencies": { "devDependencies": {
"@babel/types": "^7.18.4", "@babel/types": "^7.18.4",
"@ionic/eslint-config": "^0.3.0", "@ionic/eslint-config": "^0.3.0",