feat: update documentation #1040

sdo-1A · 2023-10-18T15:07:16Z

No description provided.

vscaiceanu-1a · 2023-10-19T08:35:57Z

README.md


-  - `crossorigin` Flag that sets crossorigin attribute on links. If true it will be set for all prefetched resources.
+1. By running the install command above, the following lines should have been added to the application's `angular.json`:


Suggested change

1. By running the install command above, the following lines should have been added to the application's `angular.json`:

1. By running the `ng add` command above, the following lines should have been added to the application's `angular.json`:

vscaiceanu-1a · 2023-10-19T09:20:01Z

docs/HOW_IT_WORKS.md

is there a link from the main readme to this doc?

vscaiceanu-1a · 2023-10-19T09:21:06Z

docs/HOW_IT_WORKS.md

+
+After adding a service worker to your project, as specified in the [prerequisites](README.md#prerequisites), the modifications include 
+the creation of a service worker configuration file called `ngsw-config.json`, which specifies the caching behaviors. 
+Then the build process creates the manifest file `ngsw.json` using information from `ngsw-configuration.json`.


ngsw-configuration.json -> ngsw-config.json

we should mention that ngsw.json is in the dist folder

README.md

cpaulve-1A · 2023-10-19T12:56:03Z

README.md

+## Builder options
+  - `targetBuild` **Mandatory** The target build where prefetch should be applied. Used for identifying the `outputPath` of the build.
+
+  - `resourceTypes` An object describing the resource types that should be prefetched.


Is there any constraints related to the key of said object? For instance would "img": ["png"] still be valid?
Does it follow a schema?

@vscaiceanu-1a

@cpaulve-1A it's just an object. https://github.com/AmadeusITGroup/ngx-prefetch/blob/master/src/schema.json#L9C1-L10C1

pginoux-1A · 2023-10-19T15:45:33Z

README.md

@@ -19,46 +19,78 @@ In some cases, it is possible to prefetch the static resources of an application
 The prefetch builder generates a `ngxPrefetch.js` file that should be included in the HTML page of the entry point. When run, it dynamically [creates `<link>` tags](https://developer.mozilla.org/en-US/docs/Web/HTTP/Link_prefetching_FAQ) for each static resource (such as JS and CSS files) so that the browser can prefetch them during idle times. This will improve the Page Load Time of the application when it is actually loaded.


We could give a bit more explanation here: "This will improve the Page Load Time of the application when it is actually loaded" => This will improve the Page Load Time of the application when the application it accessed for the first time. Then the browser caching will take over, until a new version of the application is deployed or the browser application cache is cleared.

vscaiceanu-1a · 2023-10-20T13:57:08Z

docs/HOW_IT_WORKS.md

+- `{DYNAMIC_CONTENT_PATH}`: the path where the dynamic resources are hosted (`"mydynamiccontentpath"` for example)
+- `{DYNAMIC_CONTENT_FILES}`: the path of the dynamic content files relative to the dynamic content path (expects a format like the following example: `["relativePath/myfile1", "relativePath/myfile2"]`)
+
+### HTLM header


LINK elements in header

vscaiceanu-1a · 2023-10-20T13:59:29Z

README.md

@@ -89,6 +89,8 @@ Please refer to the details on how the ngx-prefetch works [here](docs/HOW_IT_WOR
  If this is not the case, you can configure the full path of the resources that will be prefetched (ex: https://my-web-app.com/path/to/my-app/). 
  It is also possible to set this value at runtime. Instead of setting it in the Builder's options, you can search for `{STATICS_FULL_PATH}` and replace it on the server side in order to inject a path.

+  - `localizationPattern` Pattern for the relative path of the localization file. By default, the pattern corresponds to the JSON file in a folder called localizations: `"/localizations/${language}.json"`.


we should mention that if path contains the ${language} part, it will be replaced on the server side.

sdo-1A requested a review from a team as a code owner October 18, 2023 15:07

sdo-1A force-pushed the feat/update-doc branch from 4c1d57a to e2eba1e Compare October 19, 2023 09:06

vscaiceanu-1a reviewed Oct 19, 2023

View reviewed changes

sdo-1A force-pushed the feat/update-doc branch from e2eba1e to 9d3192e Compare October 19, 2023 09:32

fpaul-1A reviewed Oct 19, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

sdo-1A force-pushed the feat/update-doc branch 2 times, most recently from e708a94 to cb0eaed Compare October 19, 2023 11:57

fpaul-1A previously approved these changes Oct 19, 2023

View reviewed changes

vscaiceanu-1a previously approved these changes Oct 19, 2023

View reviewed changes

cpaulve-1A reviewed Oct 19, 2023

View reviewed changes

sdo-1A dismissed stale reviews from vscaiceanu-1a and fpaul-1A via f794701 October 19, 2023 14:46

sdo-1A force-pushed the feat/update-doc branch from cb0eaed to f794701 Compare October 19, 2023 14:46

pginoux-1A reviewed Oct 19, 2023

View reviewed changes

feat: update documentation

06ce5c3

sdo-1A force-pushed the feat/update-doc branch from f794701 to 06ce5c3 Compare October 20, 2023 07:29

vscaiceanu-1a reviewed Oct 20, 2023

View reviewed changes

sdo-1A force-pushed the feat/update-doc branch from 28dad98 to bd21aa5 Compare October 20, 2023 14:55

feat: update documentation with dynamic content

9800245

sdo-1A force-pushed the feat/update-doc branch from bd21aa5 to 9800245 Compare October 20, 2023 15:00

vscaiceanu-1a approved these changes Oct 20, 2023

View reviewed changes

fpaul-1A approved these changes Oct 20, 2023

View reviewed changes

sdo-1A merged commit e5eda83 into master Oct 20, 2023
1 check passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: update documentation #1040

feat: update documentation #1040

sdo-1A commented Oct 18, 2023

vscaiceanu-1a Oct 19, 2023

vscaiceanu-1a Oct 19, 2023

vscaiceanu-1a Oct 19, 2023

cpaulve-1A Oct 19, 2023

sdo-1A Oct 19, 2023

vscaiceanu-1a Oct 19, 2023

pginoux-1A Oct 19, 2023

vscaiceanu-1a Oct 20, 2023

vscaiceanu-1a Oct 20, 2023


		- `crossorigin` Flag that sets crossorigin attribute on links. If true it will be set for all prefetched resources.
		1. By running the install command above, the following lines should have been added to the application's `angular.json`:

	1. By running the install command above, the following lines should have been added to the application's `angular.json`:
	1. By running the `ng add` command above, the following lines should have been added to the application's `angular.json`:

		@@ -19,46 +19,78 @@ In some cases, it is possible to prefetch the static resources of an application
		The prefetch builder generates a `ngxPrefetch.js` file that should be included in the HTML page of the entry point. When run, it dynamically [creates `<link>` tags](https://developer.mozilla.org/en-US/docs/Web/HTTP/Link_prefetching_FAQ) for each static resource (such as JS and CSS files) so that the browser can prefetch them during idle times. This will improve the Page Load Time of the application when it is actually loaded.

feat: update documentation #1040

feat: update documentation #1040

Conversation

sdo-1A commented Oct 18, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment