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

Better reference link to the NS documentation #165

Open
msaelices opened this issue Jun 26, 2018 · 4 comments
Open

Better reference link to the NS documentation #165

msaelices opened this issue Jun 26, 2018 · 4 comments

Comments

@msaelices
Copy link
Contributor

msaelices commented Jun 26, 2018

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

@rigor789 If you are ok on this issue I can implement it.

@msaelices
Copy link
Contributor Author

@rigor789 It was very fast so I added that here: #166

If you want I can complete the rest of the articles with NS doc references.

@rigor789
Copy link
Member

rigor789 commented Jul 3, 2018

@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)

@msaelices
Copy link
Contributor Author

@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.

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

No branches or pull requests

2 participants