ngxs / store

🚀 NGXS - State Management for Angular
http://ngxs.io
MIT License
3.53k stars 400 forks source link

docs: introduce deprecation root pages #2146

Closed profanis closed 6 months ago

profanis commented 6 months ago

The reason for this change is the following:

Let's assume a developer works in a company where they decide to migrate to the version where the select decorator is deprecated. Although it's being deprecated they might need some time to convert their code. At the same time, they might need/want to read about the select decorator. If we completely remove the docs, it's harder for them to find the information they are looking for

image

nx-cloud[bot] commented 6 months ago

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 09418a48a0676309dda620cb89abd5121957b80d. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 5 targets - [`nx run-many --target=test --all --configuration=ci --maxWorkers=4`](https://cloud.nx.app/runs/cePmvt7TjU?utm_source=pull-request&utm_medium=comment) - [`nx run-many --target=lint --all`](https://cloud.nx.app/runs/PwlD5DDp9j?utm_source=pull-request&utm_medium=comment) - [`nx lint-types signals`](https://cloud.nx.app/runs/3VTqGVxnUu?utm_source=pull-request&utm_medium=comment) - [`nx lint-types store`](https://cloud.nx.app/runs/TKudjjjFar?utm_source=pull-request&utm_medium=comment) - [`nx run-many --target=build --all`](https://cloud.nx.app/runs/2PWDi6bQMl?utm_source=pull-request&utm_medium=comment)

Sent with 💌 from NxCloud.

bundlemon[bot] commented 6 months ago

BundleMon (Integration Projects)

Unchanged files (2) Status | Path | Size | Limits :------------: | ------------ | :------------: | :------------: :white_check_mark: | Main bundles(Gzip)
hello-world-ng17/dist-integration/main.(hash)
.js
| 68.49KB | +1% :white_check_mark: | Main bundles(Gzip)
hello-world-ng16/dist-integration/main.(hash)
.js
| 67.03KB | +1%

Total files change +9B +0.01%

Final result: :white_check_mark:

View report in BundleMon website ➡️


Current branch size history | Target branch size history

profanis commented 6 months ago

We need to update the docs references in the deprecation doc comments in the actual code too.

@markwhitfeld I am afraid I didn't get what needs to be fixed.

arturovt commented 6 months ago

I think Mark refers to this code:

image

arturovt commented 6 months ago

And for children too

profanis commented 6 months ago

We need to update the docs references in the deprecation doc comments in the actual code too.

I updated the doc references @markwhitfeld

codeclimate[bot] commented 6 months ago

Code Climate has analyzed commit 09418a48 and detected 0 issues on this pull request.

The test coverage on the diff in this pull request is 100.0% (50% is the threshold).

This pull request will bring the total coverage in the repository to 95.2% (0.0% change).

View more on Code Climate.