v-mapbox icon indicating copy to clipboard operation
v-mapbox copied to clipboard

Published 20 hours ago • verified publisher icon vinayakkulkarni

Wrong docs link

Open iBobik opened this issue 2 years ago • 5 comments

Github repo has link to outdated docs:

Snímek obrazovky 2022-06-09 v 19 50 04

iBobik avatar Jun 09 '22 17:06 iBobik

But also link in readme (v-mapbox.netlify.app) seems very inconsistent with the code. Even basic thinks like props of VMap, name of most of components (prefix Mgl vs. V, VMap, GLMap, …). Seems like from different project.

iBobik avatar Jun 09 '22 22:06 iBobik

Docs issue already filed: #854

iBobik avatar Jun 10 '22 15:06 iBobik

I'm fairly mystified by this component. Even a straight copy paste from the docs fails out complaining about needing an "options" thing.

This component LOOKS like its being maintained, but the docs suggest otherwise. Am I missing something here?

shayneoneill avatar Nov 28 '22 12:11 shayneoneill

I'm fairly mystified by this component. Even a straight copy paste from the docs fails out complaining about needing an "options" thing.

This component LOOKS like its being maintained, but the docs suggest otherwise. Am I missing something here?

Hey @shayneoneill & all,

I am planning on re-writing the docs using docus as mentioned in #854. Need extra time to work on OSS ;)

vinayakkulkarni avatar Mar 09 '23 20:03 vinayakkulkarni

It would be useful for the docs simply to have a notice on the front page of the documentation stating what is out-of-date, to help orientate people, with a few quick pointers.

There seems to be:

  • The switch to maplibre (great!)
  • Vue 3.x support
  • Component name changes
  • Composition API aspects

A few notes giving some quick simple pointers on that would be a massive help, in lieu of the actual fuller documentation changes to follow later.

mvl22 avatar May 02 '23 12:05 mvl22