Skip to content
This repository has been archived by the owner on Jul 10, 2023. It is now read-only.

Can't update docs #457

Closed
birkskyum opened this issue May 19, 2023 · 7 comments · Fixed by #458
Closed

Can't update docs #457

birkskyum opened this issue May 19, 2023 · 7 comments · Fixed by #458

Comments

@birkskyum
Copy link
Member

birkskyum commented May 19, 2023

When trying to run the docs with the 3.0.0-pre-releases I get warnings with the format:
Table of contents defined sorting of LngLatBoundsLike but no documentation with that namepath was found

These issues occur for an increasing amount of pages, which means that they will not appear in the navigation menus, and if the urls are accessed directly, the http request will not return.

Here are the pages I get errors from:

I see the first errors from Pre.2. Docs missing for:
TouchZoomRotateHandler
TouchPitchHandler

They should i.e. appear in the bottom of this list
Screenshot 2023-05-19 at 15 54 27

Another from Pre.4. Docs missing for:
clearStorage
.. and errors introduced earlier

And from Pre.6, docs for all of these pages are missing, blocking the web server from even starting:
Map
workerCount
maxParallelImageRequests
supported
setRTLTextPlugin
getRTLTextPluginStatus
addProtocol
removeProtocol
AnimationOptions
CameraOptions
PaddingOptions
RequestParameters
StyleImageInterface
CustomLayerInterface
prewarm
clearPrewarmedResources
Marker
Popup
IControl
NavigationControl
GeolocateControl
AttributionControl
ScaleControl
FullscreenControl
LngLat
LngLatLike
LngLatBounds
LngLatBoundsLike
PointLike
MercatorCoordinate
EdgeInsets
BoxZoomHandler
ScrollZoomHandler
DragPanHandler
DragRotateHandler
KeyboardHandler
DoubleClickZoomHandler
GeoJSONSource
VideoSource
ImageSource
CanvasSource
CanvasSourceOptions
Evented
MapMouseEvent
MapTouchEvent
MapLibreZoomEvent
MapDataEvent
MapWheelEvent
.. and errors introduced earlier

@birkskyum
Copy link
Member Author

birkskyum commented May 19, 2023

It looked similar to this issue emberjs/ember-test-helpers#596, and after merging the mentioned fix in DocumentationJS, releasing a 14.0.2, and trying it out locally by updating documentation to 14.0.2 in this repo, the issue persist.

@birkskyum
Copy link
Member Author

The issues of Pre.2 originate from the following renaming:

  • TouchZoomRotateHandler -> TwoFingersTouchZoomRotateHandler
  • TwoFingersTouchPitchHandler -> TwoFingersTouchPitchHandler

They happened here: https://github.com/maplibre/maplibre-gl-js/pull/1852/files

I can't see this "Touch navigation control fixes" listed in the changelog for in pre.2..

@HarelM
Copy link
Contributor

HarelM commented May 19, 2023

Last entry in the pre.2 change log.
Does renaming a class breaks the docs?

@birkskyum
Copy link
Member Author

Yes, because the class names are hardcoded in the navigations menus.

@birkskyum
Copy link
Member Author

birkskyum commented May 19, 2023

Try searching for "TouchZoomRotateHandler" in this long hardcoded table of content for the whole site https://github.com/maplibre/maplibre-gl-js-docs/blob/main/docs/documentation.yml - that list is what goes into the handlers side menu that I posted a picture of above. They now need to be prepended with "TwoFingers..." to extract the data from our jsdoc and work.

@birkskyum
Copy link
Member Author

birkskyum commented May 19, 2023

Pre.4

and clearStorage was removed here - so it should just be deleted from the TOC

So with these changes, the docs would work up to and including pre.5

@birkskyum
Copy link
Member Author

birkskyum commented May 19, 2023

Pre.6 - All this is becase of:

export type * from '@maplibre/maplibre-gl-style-spec';

Where it says SyntaxError: Unexpected token (38:12) which is the asterisk

Typed-only import/export apparently isn't supported

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants