diff --git a/README.md b/README.md index 8aef37a8..d649a50f 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![npm](https://img.shields.io/npm/v/%40ngrx-toolkit%2Fcore.svg)](https://www.npmjs.com/package/%40ngrx-toolkit%2Fcore) - + NgRx Toolkit is a set of extensions to the NgRx Signals Store, like diff --git a/docs/docs/mutations.md b/docs/docs/mutations.md index f1b52140..b0ed4eca 100644 --- a/docs/docs/mutations.md +++ b/docs/docs/mutations.md @@ -34,7 +34,7 @@ This guide covers - State signals available (`value/status/error/isPending`) - For `httpMutation`, the response type is specified with the param `parse: (res: T) => res as T` - - `hasValue` signal to narrow type. ⚠️NOTE⚠️: currently there is an [outstanding bug](https://github.com/ngrx-toolkit/ngrx-toolkit/issues/235) that this does not properly narrow. + - `hasValue` signal to narrow type. ⚠️NOTE⚠️: currently there is an [outstanding bug](https://github.com/ngrx-toolkit/core/issues/235) that this does not properly narrow. - [How to use](#usage-withmutations-or-solo-functions), as: - _standalone functions_ - In `withMutations` store _feature_ diff --git a/docs/docs/team.md b/docs/docs/team.md index 474890da..96c3f16c 100644 --- a/docs/docs/team.md +++ b/docs/docs/team.md @@ -15,4 +15,4 @@ import Team from '@site/src/components/Team'; ## Contribute -We welcome contributions from the community! If you're interested in contributing to NgRx Toolkit, check out our [GitHub repository](https://github.com/ngrx-toolkit/ngrx-toolkit) and our [contribution guidelines](https://github.com/ngrx-toolkit/ngrx-toolkit/blob/main/CONTRIBUTING.md). +We welcome contributions from the community! If you're interested in contributing to NgRx Toolkit, check out our [GitHub repository](https://github.com/ngrx-toolkit/core) and our [contribution guidelines](https://github.com/ngrx-toolkit/core/blob/main/CONTRIBUTING.md). diff --git a/docs/docs/with-devtools.md b/docs/docs/with-devtools.md index e29b7143..23bba69e 100644 --- a/docs/docs/with-devtools.md +++ b/docs/docs/with-devtools.md @@ -27,7 +27,7 @@ export const FlightStore = signalStore( After that, open your app and navigate to the component that uses the store. Open the Devtools and you will see the `flights` store in the Devtools under the name "NgRx Signal Store" -You can find a working example in the [demo app](https://github.com/ngrx-toolkit/ngrx-toolkit/blob/main/apps/demo/src/app/devtools/todo-store.ts). +You can find a working example in the [demo app](https://github.com/ngrx-toolkit/core/blob/main/apps/demo/src/app/devtools/todo-store.ts). :::info The extensions don't activate during app initialization (as it is with `@ngrx/store`). You need to open the Devtools and select the "NgRx Signal Store" tab to activate them. diff --git a/docs/docs/with-feature-factory.md b/docs/docs/with-feature-factory.md index f5753528..421d47e8 100644 --- a/docs/docs/with-feature-factory.md +++ b/docs/docs/with-feature-factory.md @@ -24,5 +24,5 @@ Use `import { withFeature } from '@ngrx/signals'` instead. - NgRx PR: ["feat(signals): add `withFeature` #4739"](https://github.com/ngrx/platform/pull/4739) - NgRx [documentation section](https://ngrx.io/guide/signals/signal-store/custom-store-features#connecting-a-custom-feature-with-the-store) on `withFeature` -In the future, `withFeatureFactory` will likely be removed, provided a right migration path is prepared. Watch out for PRs, and see [the PR that deprecates `withFeatureFactory` for the initial plan for handling the removal](https://github.com/ngrx-toolkit/ngrx-toolkit/pull/167#pullrequestreview-2735443379). +In the future, `withFeatureFactory` will likely be removed, provided a right migration path is prepared. Watch out for PRs, and see [the PR that deprecates `withFeatureFactory` for the initial plan for handling the removal](https://github.com/ngrx-toolkit/core/pull/167#pullrequestreview-2735443379). ::: diff --git a/docs/docs/with-resource.md b/docs/docs/with-resource.md index e5add5d1..b0277812 100644 --- a/docs/docs/with-resource.md +++ b/docs/docs/with-resource.md @@ -127,7 +127,7 @@ Options: 1. `'previous value'`. The resource's previous value will be returned. 1. `'native'`. No special handling is provided, inline with default error behavior. -Under the hood, `'previous value'` and `'undefined value'` proxy the value. For a detailed explanation for why this is done, check out the [JSDoc for the error handling strategy](https://github.com/ngrx-toolkit/ngrx-toolkit/blob/main/libs/ngrx-toolkit/src/lib/with-resource.ts#L402). +Under the hood, `'previous value'` and `'undefined value'` proxy the value. For a detailed explanation for why this is done, check out the [JSDoc for the error handling strategy](https://github.com/ngrx-toolkit/core/blob/main/libs/ngrx-toolkit/src/lib/with-resource.ts#L402). The implications of `undefined value` is that the inferred value can be `undefined`, even if there is a `defaultValue` set for the resource. For example, in the [`Updating`](#updating) section, `listValue` will be inferred as `User[] | undefined`. To be able to infer the type with a guaranteed value, diff --git a/docs/docusaurus.config.ts b/docs/docusaurus.config.ts index 4b783b87..31d6e9bd 100644 --- a/docs/docusaurus.config.ts +++ b/docs/docusaurus.config.ts @@ -52,8 +52,7 @@ const config: Config = { sidebarPath: './sidebars.ts', // Please change this to your repo. // Remove this to remove the "edit this page" links. - editUrl: - 'https://github.com/ngrx-toolkit/ngrx-toolkit/tree/main/docs/', + editUrl: 'https://github.com/ngrx-toolkit/core/tree/main/docs/', }, blog: false, theme: { @@ -101,7 +100,7 @@ const config: Config = { label: 'Community', }, { - href: 'https://github.com/ngrx-toolkit/ngrx-toolkit', + href: 'https://github.com/ngrx-toolkit/core', label: 'GitHub', position: 'right', }, diff --git a/libs/ngrx-toolkit/README.md b/libs/ngrx-toolkit/README.md index e30bd2b1..dff8e1af 100644 --- a/libs/ngrx-toolkit/README.md +++ b/libs/ngrx-toolkit/README.md @@ -1,6 +1,6 @@ # NgRx Toolkit - + NgRx Toolkit is a set of extensions to the NgRx Signals Store, like diff --git a/libs/ngrx-toolkit/package.json b/libs/ngrx-toolkit/package.json index 7ee6e54d..558a9d22 100644 --- a/libs/ngrx-toolkit/package.json +++ b/libs/ngrx-toolkit/package.json @@ -4,7 +4,7 @@ "license": "MIT", "repository": { "type": "GitHub", - "url": "https://github.com/ngrx-toolkit/ngrx-toolkit" + "url": "https://github.com/ngrx-toolkit/core" }, "publishConfig": { "access": "public" diff --git a/libs/ngrx-toolkit/src/lib/devtools/with-devtools.ts b/libs/ngrx-toolkit/src/lib/devtools/with-devtools.ts index f77643c4..04c8d787 100644 --- a/libs/ngrx-toolkit/src/lib/devtools/with-devtools.ts +++ b/libs/ngrx-toolkit/src/lib/devtools/with-devtools.ts @@ -15,7 +15,7 @@ import { import { DevtoolsSyncer } from './internal/devtools-syncer.service'; import { ReduxDevtoolsExtension } from './internal/models'; -// Users requested that we export this type: https://github.com/ngrx-toolkit/ngrx-toolkit/issues/178 +// Users requested that we export this type: https://github.com/ngrx-toolkit/core/issues/178 export type DevtoolsFeature = DevtoolsFeatureInternal; declare global { diff --git a/libs/ngrx-toolkit/src/lib/with-mutations.spec.ts b/libs/ngrx-toolkit/src/lib/with-mutations.spec.ts index f1392671..3be78f96 100644 --- a/libs/ngrx-toolkit/src/lib/with-mutations.spec.ts +++ b/libs/ngrx-toolkit/src/lib/with-mutations.spec.ts @@ -538,7 +538,7 @@ describe('withMutations with rxMutation', () => { }); it('does not expose mutation properties directly, only the method', async () => { - // Test case for https://github.com/ngrx-toolkit/ngrx-toolkit/issues/286 + // Test case for https://github.com/ngrx-toolkit/core/issues/286 const testSetup = createTestSetup(switchOp); const store = testSetup.store; @@ -548,7 +548,7 @@ describe('withMutations with rxMutation', () => { }); it('types mutation method as plain callable Promise signature and returns nothing else from a mutation', () => { - // Test case for https://github.com/ngrx-toolkit/ngrx-toolkit/issues/286 + // Test case for https://github.com/ngrx-toolkit/core/issues/286 const testSetup = createTestSetup(); const store = testSetup.store;