@panoramax/web-viewer 4.4.0-develop-3839b5a4 → 4.4.0-develop-f91f6758

package/config/webpackDevServer.config.js

@@ -1,131 +0,0 @@
-'use strict';
-
-const fs = require('fs');
-const evalSourceMapMiddleware = require('react-dev-utils/evalSourceMapMiddleware');
-const noopServiceWorkerMiddleware = require('react-dev-utils/noopServiceWorkerMiddleware');
-const ignoredFiles = require('react-dev-utils/ignoredFiles');
-const redirectServedPath = require('react-dev-utils/redirectServedPathMiddleware');
-const paths = require('./paths');
-const getHttpsConfig = require('./getHttpsConfig');
-
-const host = process.env.HOST || '0.0.0.0';
-const sockHost = process.env.WDS_SOCKET_HOST;
-const sockPath = process.env.WDS_SOCKET_PATH; // default: '/ws'
-const sockPort = process.env.WDS_SOCKET_PORT;
-
-module.exports = function (proxy, allowedHost) {
-  const disableFirewall =
-    !proxy || process.env.DANGEROUSLY_DISABLE_HOST_CHECK === 'true';
-  return {
-    // WebpackDevServer 2.4.3 introduced a security fix that prevents remote
-    // websites from potentially accessing local content through DNS rebinding:
-    // https://github.com/webpack/webpack-dev-server/issues/887
-    // https://medium.com/webpack/webpack-dev-server-middleware-security-issues-1489d950874a
-    // However, it made several existing use cases such as development in cloud
-    // environment or subdomains in development significantly more complicated:
-    // https://github.com/facebook/create-react-app/issues/2271
-    // https://github.com/facebook/create-react-app/issues/2233
-    // While we're investigating better solutions, for now we will take a
-    // compromise. Since our WDS configuration only serves files in the `public`
-    // folder we won't consider accessing them a vulnerability. However, if you
-    // use the `proxy` feature, it gets more dangerous because it can expose
-    // remote code execution vulnerabilities in backends like Django and Rails.
-    // So we will disable the host check normally, but enable it if you have
-    // specified the `proxy` setting. Finally, we let you override it if you
-    // really know what you're doing with a special environment variable.
-    // Note: ["localhost", ".localhost"] will support subdomains - but we might
-    // want to allow setting the allowedHosts manually for more complex setups
-    allowedHosts: disableFirewall ? 'all' : [allowedHost],
-    headers: {
-      'Access-Control-Allow-Origin': '*',
-      'Access-Control-Allow-Methods': '*',
-      'Access-Control-Allow-Headers': '*',
-    },
-    // Enable gzip compression of generated files.
-    compress: true,
-    static: {
-      // By default WebpackDevServer serves physical files from current directory
-      // in addition to all the virtual build products that it serves from memory.
-      // This is confusing because those files won’t automatically be available in
-      // production build folder unless we copy them. However, copying the whole
-      // project directory is dangerous because we may expose sensitive files.
-      // Instead, we establish a convention that only files in `public` directory
-      // get served. Our build script will copy `public` into the `build` folder.
-      // In `index.html`, you can get URL of `public` folder with %PUBLIC_URL%:
-      // <link rel="icon" href="%PUBLIC_URL%/favicon.ico">
-      // In JavaScript code, you can access it with `process.env.PUBLIC_URL`.
-      // Note that we only recommend to use `public` folder as an escape hatch
-      // for files like `favicon.ico`, `manifest.json`, and libraries that are
-      // for some reason broken when imported through webpack. If you just want to
-      // use an image, put it in `src` and `import` it from JavaScript instead.
-      directory: paths.appPublic,
-      publicPath: [paths.publicUrlOrPath],
-      // By default files from `contentBase` will not trigger a page reload.
-      watch: {
-        // Reportedly, this avoids CPU overload on some systems.
-        // https://github.com/facebook/create-react-app/issues/293
-        // src/node_modules is not ignored to support absolute imports
-        // https://github.com/facebook/create-react-app/issues/1065
-        ignored: ignoredFiles(paths.appSrc),
-      },
-    },
-    client: {
-      webSocketURL: {
-        // Enable custom sockjs pathname for websocket connection to hot reloading server.
-        // Enable custom sockjs hostname, pathname and port for websocket connection
-        // to hot reloading server.
-        hostname: sockHost,
-        pathname: sockPath,
-        port: sockPort,
-      },
-      overlay: {
-        errors: true,
-        warnings: false,
-      },
-    },
-    devMiddleware: {
-      // It is important to tell WebpackDevServer to use the same "publicPath" path as
-      // we specified in the webpack config. When homepage is '.', default to serving
-      // from the root.
-      // remove last slash so user can land on `/test` instead of `/test/`
-      publicPath: paths.publicUrlOrPath.slice(0, -1),
-    },
-
-    server: getHttpsConfig(),
-    host,
-    historyApiFallback: {
-      // Paths with dots should still use the history fallback.
-      // See https://github.com/facebook/create-react-app/issues/387.
-      disableDotRule: true,
-      index: paths.publicUrlOrPath,
-    },
-    // `proxy` is run between `before` and `after` `webpack-dev-server` hooks
-    proxy,
-    setupMiddlewares: (middlewares, devServer) => {
-      if (!devServer) {
-        throw new Error("webpack-dev-server is not defined");
-      }
-      // Keep `evalSourceMapMiddleware`
-      // middlewares before `redirectServedPath` otherwise will not have any effect
-      // This lets us fetch source contents from webpack for the error overlay
-      devServer.app.use(evalSourceMapMiddleware(devServer));
-
-      if (fs.existsSync(paths.proxySetup)) {
-        // This registers user provided middleware for proxy reasons
-        require(paths.proxySetup)(devServer.app);
-      }
-
-      // Redirect to `PUBLIC_URL` or `homepage` from `package.json` if url not match
-      devServer.app.use(redirectServedPath(paths.publicUrlOrPath));
-
-      // This service worker file is effectively a 'no-op' that will reset any
-      // previous service worker registered for the same host:port combination.
-      // We do this in development to avoid hitting the production cache if
-      // it used the same host and port.
-      // https://github.com/facebook/create-react-app/issues/2272#issuecomment-302832432
-      devServer.app.use(noopServiceWorkerMiddleware(paths.publicUrlOrPath));
-
-      return middlewares;
-    },
-  };
-};

package/docs/03_URL_settings.md

@@ -1,218 +0,0 @@
-# URL settings
-
-Various settings could be set from URL query part in order to create permalinks.
-
-These are set after the `?` symbol of the URL, following a `key=value` format, each being separated by `&` symbol.
-
-Example:
-
-```urlencoded
-https://api.panoramax.xyz/?map=19.51/48.1204522/-1.7199004&pic=890b6268-7716-4e34-ada9-69985e6c1657
-```
-
-!!! note
-
-	This works only for __Viewer__ and __Photo Viewer__ components, not for __Editor__ or __Coverage Map__.
-
-## :fontawesome-solid-computer: Interface settings
-
-### :material-target: `focus`: main shown element
-
-Switch to choose which element between map or picture should be shown wide at start. Examples:
-
-- `focus=map`
-- `focus=pic`
-
-By default, picture is shown wide.
-
-!!! note
-
-	In versions prior to 4.0.0, another `meta` value was also available to display picture metadata popup. As this part of interface is shown directly on picture side since 4.0.0, this parameter was removed. If present, picture is shown focused.
-
-### :simple-speedtest: `speed`: sequence play speed
-
-The duration of stay on a picture during sequence play (excluding image downloading time), in milliseconds. Authorized values are between 0 and 3000. Example:
-
-```urlencoded
-speed=1000
-```
-
-### :lock: `nav`: allowed navigation between pictures
-
-Choose the allowed navigation between pictures, to eventually restrict what is visible from first shown picture. Values are:
-
-- `nav=any` (or no value): no restriction in navigation (default)
-- `nav=seq`: can only see pictures in same sequence
-- `nav=none/pic`: can only see current picture, no navigation to other picture allowed
-
-## :material-image: Picture settings
-
-### :material-barcode: `pic`: picture ID
-
-The currently selected picture ID. Example:
-
-```urlencoded
-pic=890b6268-7716-4e34-ada9-69985e6c1657
-```
-
-### :material-barcode: `seq`: sequence ID
-
-The currently selected sequence ID. Example:
-
-```urlencoded
-seq=b3bae33e-cba2-464f-a0d1-d9f80b1958b0
-```
-
-### :material-arrow-all: `xyz`: picture position
-
-The shown position in picture, following this format:
-
-```
-x/y/z
-```
-
-With:
-
-- `x`: the heading in degrees (0 = North, 90 = East, 180 = South, 270 = West)
-- `y`: top/bottom position in degrees (-90 = bottom, 0 = front, 90 = top)
-- `z`: zoom level (0 = minimum/wide view, 100 = maximum/full zoom)
-
-Example:
-
-```urlencoded
-xyz=10/25/50
-```
-
-### :material-tag-arrow-right: `xywh`: picture position (annotation format)
-
-The position to show on picture at first load, in common annotation format.
-
-```
-x,y,w,h
-```
-
-With:
-
-- `x`: the horizontal offset compared to original picture left border (in pixels)
-- `y`: the vertical offset compared to original picture top border (in pixels)
-- `w`: the area width (in pixels)
-- `h`: the area height (in pixels)
-
-Example:
-
-```urlencoded
-xywh=3520,1264,96,112
-```
-
-### :label: `annot`: selected picture annotation
-
-The annotation UUID to focus on at picture load. Only works in combination with `pic` parameter.
-
-```urlencoded
-annot=fe298d59-a9c6-4680-8e76-6efe82d97f46&pic=52c30227-c5fb-4536-bb13-8c36cabf22ea
-```
-
-## :map: Map settings
-
-### :fontawesome-solid-location-dot: `map`: map position and visibility
-
-The `map` parameters handles both map visibility and position. It can take different values:
-
-- `map=zoom/latitude/longitude`: for setting the map position (following [MapLibre GL JS hash format](https://maplibre.org/maplibre-gl-js/docs/API/type-aliases/MapOptions/#hash)). It updates automatically when map is moved.
-- no parameter set: shows the map of the whole world, or zoomed on instance area of interest.
-
-Example:
-
-```urlencoded
-map=19.51/48.1204522/-1.7199004
-```
-
-### :date: `date_from` and `date_to`: filter map data by date
-
-Minimum and maximum capture date for pictures and sequences to show on map (if map is enabled), in ISO format:
-
-```urlencoded
-date_from=2020-01-01&date_to=2023-12-31
-```
-
-### :material-rotate-360: `pic_type`: filter map data by picture type
-
-The type of picture (360° or classic) to show on map (if map is enabled). Examples:
-
-- `pic_type=flat` for classic pictures
-- `pic_type=equirectangular` for 360° pictures
-- Not set for showing both
-
-### :camera: `camera`: filter map data by camera make and model
-
-The camera make and model to filter shown pictures and sequences on map (if map is enabled). A fuzzy search is used to filter on map, but your string _should_ always start with camera make. Examples:
-
-- `camera=gopro` will display all pictures taken with any _GoPro_ camera
-- `camera=gopro%20max` will only show pictures taken with a _GoPro Max_ camera
-- `camera=max` will not shown any picture on map, as it doesn't match any camera make
-
-### :medal: `pic_score`: filter map data by quality score
-
-The pictures quality level wanted for map display (if map is enabled). Values are `A`, `B`, `C`, `D`, `E` and can be used that way:
-
-- `pic_score=A` for only best pictures
-- `pic_score=ABC` for A, B or C-grade pictures
-
-
-### :material-crosshairs-gps: `gps`: filter map data by location precision
-
-The pictures location precision wanted for map display (if map is enabled). Values are `1, 2, 3, 4, 5`, and can be used like:
-
-- `gps=5` for pictures with highest precision (ranked 5 stars)
-- `gps=1,2,3` for pictures with low to medium precision (ranked 1, 2 or 3 stars)
-
-### :material-format-paint: `theme`: map colouring for pictures and sequences
-
-The map theme to use for displaying pictures and sequences (if map is enabled). Available themes are:
-
-- `theme=default` (or no setting defined): single color for display (no classification)
-- `theme=age`: color based on picture/sequence age (red = recent, yellow = 2+ years old)
-- `theme=type`: color based on camera type (orange = classic, green = 360°)
-- `theme=score`: color based on quality score (green = best quality, yellow = worst)
-- `theme=gps`: color based on location precision (green = best positioning, yellow = worst)
-
-### :material-nature-people: `background`: map background
-
-The map background to display (if map is enabled, and raster background configured). Available values are:
-
-- `background=streets` (or no setting defined): classic streets map
-- `background=aerial`: aerial imagery (only if raster background available)
-
-### :octagonal_sign: `overlay`: map semantics overlays
-
-The semantics overlay to enable by default (if map is enabled, with semantics layers associated). The value is the list of semantics overlays IDs, separated by a `,`. Example:
-
-```urlencoded
-overlay=tfsigns,other
-```
-
-### :fontawesome-solid-user: `users`: filter map data by user
-
-This parameter filters pictures and sequences shown on map to only keep those of concerned users. Authorized values are:
-
-- __All users from local instance__ with value `default`
-- __Single user UUID__ from local instance
-- __All users from metacatalog__ with value `metacatalog` (only with Viewer and `metacatalog` option not set to `false`)
-- __Single user UUID from metacatalog__, prefixed with `metacatalog_` (only with Viewer and `metacatalog` option not set to `false`)
-
-Example:
-
-```urlencoded
-users=abcdefgh-1234-5678-9012-abcdefgh12345678
-users=metacatalog_abcdefgh-1234-5678-9012-abcdefgh12345678
-```
-
-### :fontawesome-solid-building-circle-arrow-right: `level`: indoor map level
-
-__Only if Indoor maps display is enabled__ ([see the tutorial](./tutorials/indoor_maps.md))
-
-This parameters selects the indoor map level to display on map load. This should correspond to a level available in selected area. Example:
-
-```urlencoded
-level=-1
-```

package/docs/05_Compatibility.md

@@ -1,83 +0,0 @@
-# Compatibility with STAC API
-
-Panoramax viewer works best with a [Panoramax API](https://gitlab.com/panoramax/server/api), but is designed to be compatible with a wide range of [STAC API](https://github.com/radiantearth/stac-api-spec). Although, third-party STAC API needs the following requirements to work with our viewer.
-
-## :octicons-search-16: Search endpoint
-
-Your STAC API should offer a `/search` endpoint ([documentation](https://github.com/radiantearth/stac-api-spec/tree/main/item-search)).
-
-## :fontawesome-regular-images: Collections and items
-
-Collections should correspond to :fontawesome-regular-images: __pictures sequences__, and items corresponding to :fontawesome-regular-image: __individual pictures__.
-
-Individual pictures should follow [STAC item specification](https://github.com/radiantearth/stac-spec/blob/master/item-spec/item-spec.md), plus some extensions:
-
-- _Perspective imagery specification_ for its pictures and sequences metadata ([documentation](https://github.com/stac-extensions/perspective-imagery))
-- _Tiled assets specification_ for smooth display of high-resolution pictures ([documentation](https://github.com/stac-extensions/tiled-assets))
-
-??? info "List of support item metadata"
-
-    - `assets`
-        - [`roles`](https://github.com/radiantearth/stac-spec/blob/master/item-spec/item-spec.md#asset-roles): `data`, `visual` and `thumbnail`
-        - `type`: `image/jpeg` or `image/webp`
-        - `href`
-    - `assets_templates`
-        - `tiles`
-            - `role`: `data`
-            - `href`
-    - `geometry`
-    - `collection`
-    - `id`
-    - `links`
-        - [`rel`](https://github.com/radiantearth/stac-spec/blob/master/item-spec/item-spec.md#link-object): `prev`, `next`, `related`, `via`
-        - `type`: `application/geo+json` or `application/json`
-        - `id`
-        - `geometry`
-        - `datetime`
-    - `properties`
-        - `pers:interior_orientation`
-            - `field_of_view`
-            - `focal_length`
-        - `view:azimuth`
-        - `pers:roll`
-        - `pers:pitch`
-        - `datetime` or `datetimetz`
-        - `tiles:tile_matrix_sets`
-            - `geovisio`
-                - `type`: `TileMatrixSetType`
-                - `tileMatrix`
-                    - `matrixHeight`
-                    - `matrixWidth`
-                    - `tileHeight`
-                    - `tileWidth`
-
-## :map: Vector tiles
-
-If you want to use map in viewer, your STAC API should offer :map: vector tiles, through one of these ways:
-
-- A [MapLibre Style JSON](https://maplibre.org/maplibre-style-spec/) file, advertised through landing page (`/api`) with a `xyz-style` link.
-- A direct tiles URL, pointing to tiles in [MVT format](https://mapbox.github.io/vector-tile-spec/) and following layer structure described below. It must be advertised in landing page (`/api`) using [Web Map Links](https://github.com/stac-extensions/web-map-links) STAC extension (as `xyz` link).
-
-### Layers
-
-MVT Vector tiles must have the following layers:
-
-| Name | Zooms | Mandatory | Properties |
-|------|-------|:---------:|------------|
-| `sequences` | All | ✅ | - `id`: sequence ID |
-| `pictures` | >= 15 | ✅ | - `id`: picture ID<br />- `ts`: picture date/time<br />- `heading`: picture heading in degrees |
-| `grid` | < 6 | ❌ | __Mandatory:__<br />- `id`: grid cell ID<br />- `nb_pictures`: amount of pictures<br />- `coef`: value from 0 to 1, relative quantity of available pictures<br />__Optional:__<br />- `nb_360_pictures`<br />- `coef_360_pictures`<br />- `nb_flat_pictures`<br />- `coef_flat_pictures`<br />(similar to `nb_pictures` and `coef` but separated by picture type) |
-
-### Translation
-
-If your vector tiles support multiple languages, you can set in your `style.json` the list of supported languages :
-
-```json
-{
-    "metadata": {
-        "panoramax:locales": ["fr", "en", "latin"]
-    }
-}
-```
-
-The viewer will try to find the best matching `name:LANG` property according to user browser settings.

package/docs/09_Develop.md

@@ -1,141 +0,0 @@
-# Developing on the client
-
-You want to work on our library and offer bug fixes or new features ? That's awesome ! 🤩
-
-Here are some inputs about working with Panoramax web client code.
-
-!!! note
-
-    If something seems missing or incomplete, don't hesitate to contact us by [email](mailto:panoramax@panoramax.fr) or using [an issue](https://gitlab.com/panoramax/clients/web-viewer/-/issues). We really want Panoramax to be a collaborative project, so everyone is welcome (see our [code of conduct](https://gitlab.com/panoramax/clients/web-viewer/-/blob/develop/CODE_OF_CONDUCT.md)).
-
-## Architecture
-
-The current code is split between various elements:
-
-- **Core components**: a single functional entry, like [Viewer](./reference/components/core/Viewer.md) (map + picture), [Photo Viewer](./reference/components/core/PhotoViewer.md) (picture only), [Coverage Map](./reference/components/core/CoverageMap.md) or [Editor](./reference/components/core/Editor.md). They share parts of code in [Basic](./reference/components/core/Basic.md) class. They specialized the behaviour of components depending on the needs.
-- **UI components, menus & widgets**: reusable web components, like [Map](./reference/components/ui/Map.md), [Photo](./reference/components/ui/Photo.md) or [Loader](./reference/components/ui/Loader.md). They are used in some views depending of the context.
-- **Utils**: utility functions, split into various files for clarity.
-
-![Class diagram of Panoramax web viewer](./images/class_diagram.jpg)
-
-The library is relies on various other libraries:
-
-- [Lit](https://lit.dev/), for web components management
-- [Photo Sphere Viewer](https://github.com/mistic100/Photo-Sphere-Viewer), for displaying classic and 360° pictures
-- [Maplibre GL JS](https://github.com/maplibre/maplibre-gl-js), for displaying the map which shows sequences and pictures location
-- [JS Library Boilerplate](https://github.com/hodgef/js-library-boilerplate), for having a ready-to-use development toolbox
-
-## Good to know
-
-### Components `z-index`
-
-In order to offer a coherent overlay of widgets, we follow this general `z-index` ordering:
-
-| Component type                    | Z-Index |
-| --------------------------------- | :-----: |
-| MapLibre GL & Photo Sphere Viewer | <= 110  |
-| Widgets / Cornered Grid's corners |   120   |
-| Togglable menus                   |   130   |
-| Fullscreen loaders & popups       |   200   |
-
-### Parameters handling
-
-!!! note
-
-    This concerns only __Viewer__ component. Editor & Coverage Map read input parameters only from Web Components attributes.
-
-Viewer component can read parameters from 3 different sources:
-
-- Web Component **attributes**, passed through DOM
-- Browser **local storage**
-- **URL search** parameters
-
-This allows a flexible way to interact with viewer for users. Prioritization of parameters is managed by [InitParameters class](./reference/utils/InitParameters.md), URL parameters coming first, then Web component attributes, then local storage (and eventually some hard-coded defaults).
-
-This means that, when developing, if you want to check if your attributes are well-defined, you may want to get rid of URL search parameters, as well as remove the `pnx-map-parameters` local storage item. Otherwise, they may not be read as they are lower priority than others.
-
-### Third-party services URL
-
-All third-party services URL (like geocoding API, OSM iD editor) are grouped into a dedicated `src/utils/services.js` file. You can easily change them to deploy a custom version of the viewer.
-
-### Presets for semantics
-
-The semantics system for sequences, pictures and annotations make use of **tagging presets**. These are JSON files hosted at [presets.panoramax.fr](https://presets.panoramax.fr/), they have their [dedicated Gitlab repository](https://gitlab.com/panoramax/server/tagging-presets).
-
-In the viewer, they show up through icons and translated labels associated to pictures & annotations. If you want to change them, you have to edit them in Gitlab repository. Viewer automatically loads hosted files at start.
-
-### Rendering on mobile
-
-In order to improve performance, the 3D sphere used for projecting the picture on mobile has a lower amount of polygons, meaning a bit of distortions can appear on-screen. This is directly linked to [PSV Equirectangular adapter's resolution parameter](https://photo-sphere-viewer.js.org/guide/adapters/equirectangular.html#resolution).
-
-![Comparative of mobile vs PC rendering](./images/comparative_3drender.jpg)
-
-### Widgets breakpoints
-
-To make default display more adaptative, many places in the _Viewer_ code uses breakpoints to have different rendering:
-
-- Display height: 400px
-- Display width: 576px
-- Shown in iframe or not
-
-These breakpoints are both used in CSS (with media-queries) or in JS (`isWidthSmall, isHeightSmall, isInIframe`).
-
-## Testing
-
-We're trying to make Panoramax as reliable and secure as possible. To ensure this, we rely heavily on code testing. A variety of testing tools is made available:
-
-- `npm start` : launches a dev web server on [localhost:3000](http://localhost:3000)
-- `npm run test` : unit testing
-- `npm run lint` : syntax checks
-- `npm run coverage` : amount of tested code
-
-If you're working on bug fixes or new features, please **make sure to add appropriate tests** to keep Panoramax level of quality.
-
-### Example pictures
-
-As Panoramax accepts all kind of picture, we have a large variety of troubles that can come to display them. Here is a list of very different images (various types, orientation, metadata) that can be useful to check if your rendering is working well:
-
-| UUID                                   | Type           | Heading | Comment                    |
-| -------------------------------------- | -------------- | ------- | -------------------------- |
-| `5bada38c-7cbc-4c81-a4d1-e39480fbec0b` | flat landscape | SE      |                            |
-| `1d86cbbe-2293-4759-a4b6-23a815c49364` | flat portrait  | SW      |                            |
-| `f21d15a7-7a48-4194-bef2-09f22db03225` | flat square    | NW      | roll/pitch                 |
-| `b13976d5-fb07-44be-b6b6-2a2356a23cb8` | 360°           | W       |                            |
-| `03f220b4-28b2-4104-bc64-bb9e41a8aa5d` | 360°           | W       | picture tags + annotations |
-| `5d1800fd-44f6-446f-92b9-250f737c4b14` | 360°           | NE      | roll/pitch                 |
-| `02b6dac1-6d6a-4568-9db4-f4b0219c03d3` | 360°           | E       | roll/pitch                 |
-| `0552bbac-6054-41c1-b0d7-f06ffce7a56d` | 360°           | SW      | roll/pitch                 |
-| `2f842858-2ada-4a25-a462-8d3bf256aca8` | H-cropped 360° | -       | annotations                |
-| `66dbf066-cf13-4fe3-a32a-2210daaeb45d` | H-cropped 360° | ?       |                            |
-| `adf47cb2-cddd-4a8b-a5c9-f64248b62f90` | H-cropped 360° | SW      |                            |
-| `193245fa-3454-492a-b0fc-aa06feab772e` | 180°           | SE      |                            |
-
-## Documentation
-
-The documentation is a mix of:
-
-- [JSDoc comments](https://jsdoc.app/about-getting-started) embed directly in source files, and exported in `docs/reference/` folder
-- Higher-level docs as Markdown files, in `docs/` folder.
-
-The JSDoc can be exported as Markdown using this command:
-
-```bash
-npm run doc
-```
-
-And all documentation can be previewed or built using [Mkdocs](https://www.mkdocs.org/):
-
-```bash
-pip install mkdocs mkdocs-material
-mkdocs serve
-mkdocs build
-```
-
-Online versions are available at:
-
-- [docs.panoramax.fr](https://docs.panoramax.fr/web-viewer/) for **stable** version
-- [viewer.geovisio.fr/docs](https://viewer.geovisio.fr/docs/) for **develop** version
-
-## Make a release
-
-See [dedicated documentation](./90_Releases.md).

package/docs/90_Releases.md

@@ -1,27 +0,0 @@
-# Make a release
-
-Panoramax JS uses [semantic versioning](https://semver.org/) for its release numbers.
-
-!!! note
-
-	On versions < 3.0, a strong constraint was put to keep versions in sync between API and Viewer. Each component could have different `PATCH` versions, but compatibility __had to be__ ensured between `MAJOR.MINOR` versions. Since Viewer version >= 3.0, any STAC-compliant API should be supported by Viewer.
-
-Run these commands in order to issue a new release:
-
-```bash
-git checkout develop
-
-vim package.json		# Change version
-vim package-lock.json	# Change version
-npm run doc
-
-vim CHANGELOG.md	# Replace unreleased to version number (and links at bottom)
-
-git add *
-git commit -m "Release x.x.x"
-git tag -a x.x.x -m "Release x.x.x"
-git push origin develop
-git checkout main
-git merge develop
-git push origin main --tags
-```