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

Complete API reference #915

Closed
FrankyBoy opened this issue Jun 8, 2020 · 10 comments
Closed

Complete API reference #915

FrankyBoy opened this issue Jun 8, 2020 · 10 comments
Labels
Type: Documentation A documetation fixes

Comments

@FrankyBoy
Copy link

Hi!

It seems that right now there only are "guides" on how to do various things. However I think it would be hugely helpful if there was some actual API reference that contains all the methods/properties/etc that vue-i18n offers (i.e. all the things that $t, $tc, $i18n, ... offer).

Thanks :)

@AleksandrSl
Copy link
Contributor

Hi, have you seen this?
https://kazupon.github.io/vue-i18n/api/

@exoego
Copy link
Collaborator

exoego commented Jun 8, 2020

@FrankyBoy
As @AleksandrSl pointed out, docs site have API reference.
Does this API reference helps ?

Maybe the navigation to API reference is easily missed...
image

@exoego exoego added the Type: Documentation A documetation fixes label Jun 8, 2020
@FrankyBoy
Copy link
Author

That ... is very well hidden. Thanks for pointing that out.

Could this be made more visible somehow in the guide, as all links point to that? Ideally in the sidebar, same like you got the "Legacy" section.

@AleksandrSl
Copy link
Contributor

AleksandrSl commented Jun 8, 2020

On the one hand it's realy not so easy to find, from the other hand it repeats behaviour of Vue docs
image

@rchl
Copy link
Contributor

rchl commented Jun 8, 2020

But Vue has a lot more items that they have to fit somewhere.
For nuxt-i18n I've exposed those in the root: https://nuxt-community.github.io/nuxt-i18n/

@AleksandrSl
Copy link
Contributor

AleksandrSl commented Jun 9, 2020

@rchl your solution looks perfect to me, and vuex has the same solution

@exoego exoego added the Status: PR Welcome Welcome to Pull Request label Jun 9, 2020
@exoego
Copy link
Collaborator

exoego commented Jun 9, 2020

PR to improve navigation is welcome 🙏

@AleksandrSl
Copy link
Contributor

I will try to do it, if nobody minds

@AleksandrSl
Copy link
Contributor

Can be closed I think

@exoego
Copy link
Collaborator

exoego commented Jun 17, 2020

Thanks !!
Closing as resolved in #920 and the changes were deployed.

@exoego exoego closed this as completed Jun 17, 2020
@exoego exoego removed the Status: PR Welcome Welcome to Pull Request label Jun 17, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Documentation A documetation fixes
Projects
None yet
Development

No branches or pull requests

4 participants