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

Update documentation to explain the return values of Navigation Guards #3077

Closed
ggedde opened this issue Dec 23, 2019 · 2 comments
Closed

Update documentation to explain the return values of Navigation Guards #3077

ggedde opened this issue Dec 23, 2019 · 2 comments
Labels

Comments

@ggedde
Copy link

@ggedde ggedde commented Dec 23, 2019

What problem does this feature solve?

Currently the Guide Documentation doesn't explain the return values of the Navigation Guards. It is listed in the API Reference, but it is just a single line and very difficult to find. I honestly never found it in the Documentation when I was looking and instead found some Vue Issues with users explaining it, but never listing any documentation to it. I only found it in the API Reference by doing site find on page search for "remove".

What does the proposed API look like?

I feel that this should be shown with examples and listed in the Sidebar in its own section for "Removing Registered Guards", etc and listed in the Guide with a link to it in the API Reference.

Thanks

@posva posva added the docs label Dec 24, 2019
@posva

This comment has been minimized.

Copy link
Member

@posva posva commented Dec 24, 2019

I think that because removing guards is something most people won't need until they meet advanced use cases, it's better placed in the API section as it is now

@posva posva closed this Dec 24, 2019
@ggedde

This comment has been minimized.

Copy link
Author

@ggedde ggedde commented Dec 24, 2019

@posva That's fine, but I still think it could use some examples and should be listed in the sidebar as its own section in the API Reference to help others.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.