Better reference link to the NS documentation
msaelices opened this issue · 4 comments
Right now in almost every article documented there is the following text:
For more information about the available properties, methods, and events, head over to [the complete API documentation for XXX].
Where [the complete API documentation for XXX] copy includes a link to the NS API, which I think is useful but hard to read.
For example, the AbsoluteLayout NS-vue docs links to the AbsoluteLayout API docs which I think is less useful than linking to the AbsoluteLayout NS doc.
IMHO, the ideal solution would be link both of them, something like:
See [the NS docs] for more information about XXX. For information about the available properties, methods, and events, head over to [the complete API documentation].
@msaelices Hey! In most cases the link to the official docs contains pretty much the same information, I'm not opposed to adding a link - but initially it seemed redundant and confusing. My original goal with the docs was to keep the user on nativescript-vue.org as much as possible to reduce confusion when there are multiple pages open from different docs/sites (I find this very confusing when learning new things, and I'm redirected all over the place, after a while I loose track, and just close all tabs and start fresh)
Edit: Let's merge the PR, but only add docRef where it really makes sense (where there is actually additional information provided)
@rigor789 I agreed on to keep people in your docs if it's possible. In my personal experience reading the docs is that after I click on the API docs, I usually end up googling "Nativescript absolutelayout" and going to the https://docs.nativescript.org/ui/layouts/layout-containers#absolutelayout which for me is a great resource and almost always gave up the API docs link.
I think NS-vue docs will become more and more detailed, but there are a lot of chances for users to want more nowadays. And for this case, I almost always prefer the NS docs than the NS API docs.