Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

App-shell docs are out-of-date #55507

Closed
8th-block opened this issue Apr 24, 2024 · 0 comments
Closed

App-shell docs are out-of-date #55507

8th-block opened this issue Apr 24, 2024 · 0 comments
Labels
area: adev Angular.dev documentation good first issue An issue that is suitable for first-time contributors; often a documentation issue. help wanted An issue that is suitable for a community contributor (based on its complexity/scope). P3 An issue that is relevant to core functions, but does not impede progress. Important, but not urgent state: has PR
Milestone

Comments

@8th-block
Copy link

8th-block commented Apr 24, 2024

Describe the problem that you experienced

app-shell docs are not up-to-date.
https://angular.dev/ecosystem/service-workers/app-shell

Sections 2 and 3 need to reflect the latest and greatest.

If we follow the install steps the resulting JSON is not as described in the above doc which in turn makes step3 not work of course

Enter the URL of the topic with the problem

https://angular.dev/ecosystem/service-workers/app-shell

Describe what you were looking for in the documentation

JSON in step 2 should reflect how ng 17 produces it. This is what it adds to angular.json

{
...
          "configurations": {
            "production": {
              "budgets": [
                {
                  "type": "initial",
                  "maximumWarning": "500kb",
                  "maximumError": "1mb"
                },
                {
                  "type": "anyComponentStyle",
                  "maximumWarning": "2kb",
                  "maximumError": "4kb"
                }
              ],
              "outputHashing": "all",
              "appShell": true
            },
            "development": {
              "optimization": false,
              "extractLicenses": false,
              "sourceMap": true
            }
          },
          "defaultConfiguration": "production"
        },
}

Describe the actions that led you to experience the problem

I simply follow your instruactons ie
ng new my-app --routing
cd my-app
ng generate app-shell

Describe what you want to experience that would fix the problem

Docs needs to change to reflect the latest changes

Add a screenshot if that helps illustrate the problem

No response

If this problem caused an exception or error, please paste it here

No response

If the problem is browser-specific, please specify the device, OS, browser, and version

No response

Provide any additional information here in as much as detail as you can

No response

@pkozlowski-opensource pkozlowski-opensource added the area: adev Angular.dev documentation label Apr 24, 2024
@ngbot ngbot bot added this to the needsTriage milestone Apr 24, 2024
@bencodezen bencodezen added the P3 An issue that is relevant to core functions, but does not impede progress. Important, but not urgent label Apr 24, 2024
@ngbot ngbot bot modified the milestones: needsTriage, Backlog Apr 24, 2024
@alan-agius4 alan-agius4 added help wanted An issue that is suitable for a community contributor (based on its complexity/scope). good first issue An issue that is suitable for first-time contributors; often a documentation issue. labels Apr 25, 2024
JeanMeche added a commit to JeanMeche/angular that referenced this issue Apr 25, 2024
JeanMeche added a commit to JeanMeche/angular that referenced this issue Apr 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: adev Angular.dev documentation good first issue An issue that is suitable for first-time contributors; often a documentation issue. help wanted An issue that is suitable for a community contributor (based on its complexity/scope). P3 An issue that is relevant to core functions, but does not impede progress. Important, but not urgent state: has PR
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants