Small docs fixes

[BioPhoton]

trafficstars

Description

After clicking through the docs page I noticed a couple of things we can improve.

Tasks to Resolve

• [x] Header Menu order
• [x] Favicon
• [ ] CDK menu items re arrangement
• [ ] CDK/coercing extract concepts and link them
• [ ] Missing Setup section
• [ ] CDK/coalescing extract concepts and link them
• [ ] Remove Available approaches section
• [ ] CDK/transformations docs are missing
• [ ] Restructure @rx-angular/state side menu
• [ ] Introduce a Concepts section

Header Menu order

The current order is: CDK, ESLint, State, Template

A better order could be: State, Template, CDK, ESLint

Favicon

Favicon is not present

We should use the new logo here

CDK side menu items

ATM the CDK package shows the submodules and an additional link to API.

In the API menu there is additional information about edge cases.

I suggest moving everything not extracted from the JS docs into the main menu option

CDK/transformations docs are missing

In the docs section of transform the main docs page located on the related docs folder in transforms is missing.

We need to add them.

CDK/coalescing extract concepts and link them

In the coalescing sub package there are a couple of sections that are not directly related to RxA but rather concepts or existing ways.

the sections are:

• Coalescing of ApplicationRef#tick calls
• Coalescing with ngZoneEventCoalescing settings

Missing setup section

In many docs files we miss the setup section.

An example can look like this:

The FEATURE-XY can be imported as following:

Module based setup:

import { FeatureModule } from "@rx-angular/package/sub-package";

@NgModule({
  imports: [ FeatureModule],
  // ...
})
export class AnyModule {}

Standalone component setup:

import { FeatureModule } from "@rx-angular/package/sub-package";

@Component({
    standalone: true,
    imports: [ FeatureModule],
    template: `...`
})
export class AnyComponent {}

The following packages are missing this section:

• cdk/coalescing
• cdk/coercing
• cdk/notifications
• cdk/render-strategies
• cdk/template-management
• cdk/zone-configurations
• cdk/zone-less

Remove Available approaches section

To reduce the content and focus on the relevant things we should move the content of this section into either concepts or other sections

The following packages need to remove this section:

• cdk/coalescing
• cdk/coercing
• cdk/notifications
• cdk/render-strategies
• cdk/template-management
• cdk/zone-configurations
• cdk/zone-less

Restructure @rx-angular/state side menu

ATM the side menu contains a lot of items that need to get moved or removed. The current side menu for state looks like this:

The new structure should look like this:

• State
• Actions
• Effects
• Selections
• API

The Testing and Setup section should go into the RxState docs

The Concepts and best practices section should get renamed to Examples and the Integrations should get merged in here.

The Recipes section should move into state basic and advanced usage or into Tutorials.

The FAQ section should get removed.

The Tutorials section needs a complete reorganization and also old content needs to get removed and or moved.

Introduce a Concepts section

As we have a lot of theory around our implementations we should introduce a Concepts section for every package (maybe not for ESLint)

[phhien203]

Is there anybody working on this @BioPhoton ? If not, I think I can take this. Thanks!

[BioPhoton]

Hi @phhien203 would be awesome if you help here