Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Wrong docs link #1028

Open
iBobik opened this issue Jun 9, 2022 · 5 comments
Open

Wrong docs link #1028

iBobik opened this issue Jun 9, 2022 · 5 comments
Assignees
Labels
documentation Improvements or additions to documentation question Further information is requested

Comments

@iBobik
Copy link
Contributor

iBobik commented Jun 9, 2022

Github repo has link to outdated docs:

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

@iBobik
Copy link
Contributor Author

iBobik commented Jun 9, 2022

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
Copy link
Contributor Author

iBobik commented Jun 10, 2022

Docs issue already filed: #854

@shayneoneill
Copy link

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?

@vinayakkulkarni vinayakkulkarni added documentation Improvements or additions to documentation question Further information is requested labels Mar 9, 2023
@vinayakkulkarni vinayakkulkarni moved this to 📋 Backlog in v4.x ✨ Mar 9, 2023
@vinayakkulkarni
Copy link
Owner

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 vinayakkulkarni self-assigned this Mar 9, 2023
@mvl22
Copy link

mvl22 commented May 2, 2023

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation question Further information is requested
Projects
None yet
Development

No branches or pull requests

4 participants