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

Clarify default behavior in deep linking documentation #5116

Closed
Ryandaydev opened this issue Jan 10, 2019 · 0 comments
Closed

Clarify default behavior in deep linking documentation #5116

Ryandaydev opened this issue Jan 10, 2019 · 0 comments

Comments

@Ryandaydev
Copy link

A suggested clarification in the repo documentation (deep-linking.md).

The page says deep linking is disabled by default. That is true of the javascript itself. However, the /dist/index.html enables it, so if someone uses the /dist folder as-is, it will be enabled by default.

Suggest changing this statement to the Usage section:

Add deepLinking: true to your Swagger-UI configuration to enable this functionality.

To this:

Add deepLinking: true to your Swagger-UI configuration to enable this functionality. This is demonstrated in the /dist/index.html file.

@lock lock bot locked and limited conversation to collaborators Jan 11, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

1 participant