ngrx / platform

Reactive State for Angular
https://ngrx.io
Other
8.01k stars 1.97k forks source link

Add documentation for the ESLint rule signal-state-no-arrays-at-root-level #4501

Open timdeschryver opened 1 month ago

timdeschryver commented 1 month ago

Information

The rule signal-state-no-arrays-at-root-level should be documented at https://github.com/ngrx/platform/blob/main/projects/ngrx.io/content/guide/eslint-plugin/rules/signal-state-no-arrays-at-root-level.md.

It should also contain one or more examples showcasing some "bad" and "good" snippets. For some examples we can take a look at the test cases at https://github.com/ngrx/platform/blob/main/modules/eslint-plugin/spec/rules/signals/with-state-no-arrays-at-root-level.spec.ts.

Documentation page

https://ngrx.io/guide/eslint-plugin/rules/signal-state-no-arrays-at-root-level

I would be willing to submit a PR to fix this issue