From 03601f99d877982de8d8f96cf3889b0431687a5a Mon Sep 17 00:00:00 2001 From: Jonas Jenwald Date: Fri, 24 May 2024 11:42:06 +0200 Subject: [PATCH] Update the "File Layout Overview" docs Apparently we forgot to update this in the version 4 release, so better late than never I suppose. - Use `.mjs` extensions where appropriate. - Remove mention of the `debugger`-functionality, since that's not really relevant to users. - Unify the whitespace handling to use spaces consistently. --- docs/contents/getting_started/index.md | 25 ++++++++++++------------- 1 file changed, 12 insertions(+), 13 deletions(-) diff --git a/docs/contents/getting_started/index.md b/docs/contents/getting_started/index.md index e3c968dcf..51828202f 100644 --- a/docs/contents/getting_started/index.md +++ b/docs/contents/getting_started/index.md @@ -78,20 +78,19 @@ Note that we only mention the most relevant files and folders. ``` ├── build/ -│   ├── pdf.js - display layer -│   ├── pdf.js.map - display layer's source map -│   ├── pdf.worker.js - core layer -│   └── pdf.worker.js.map - core layer's source map +│ ├── pdf.mjs - display layer +│ ├── pdf.mjs.map - display layer's source map +│ ├── pdf.worker.mjs - core layer +│ └── pdf.worker.mjs.map - core layer's source map ├── web/ │ ├── cmaps/ - character maps (required by core) │ ├── compressed.tracemonkey-pldi-09.pdf - PDF file for testing purposes -│ ├── debugger.js - helpful debugging features │ ├── images/ - images for the viewer and annotation icons │ ├── locale/ - translation files │ ├── viewer.css - viewer style sheet │ ├── viewer.html - viewer layout -│ ├── viewer.js - viewer layer -│ └── viewer.js.map - viewer layer's source map +│ ├── viewer.mjs - viewer layer +│ └── viewer.mjs.map - viewer layer's source map └── LICENSE ``` @@ -104,16 +103,16 @@ Note that we only mention the most relevant files and folders. ├── external/ - third party code ├── l10n/ - translation files ├── src/ -│   ├── core/ - core layer -│   ├── display/ - display layer -│   ├── shared/ - shared code between the core and display layers -│   ├── interfaces.js - interface definitions for the core/display layers -│   └── pdf.*.js - wrapper files for bundling +│ ├── core/ - core layer +│ ├── display/ - display layer +│ ├── shared/ - shared code between the core and display layers +│ ├── interfaces.js - interface definitions for the core/display layers +│ └── pdf.*.js - wrapper files for bundling ├── test/ - unit, font, reference, and integration tests ├── web/ - viewer layer ├── LICENSE ├── README.md -├── gulpfile.js - build scripts/logic +├── gulpfile.mjs - build scripts/logic ├── package-lock.json - pinned dependency versions └── package.json - package definition and dependencies ```