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

Bundle documentation #148

Closed
psykokwak4 opened this issue Jun 8, 2016 · 1 comment
Closed

Bundle documentation #148

psykokwak4 opened this issue Jun 8, 2016 · 1 comment

Comments

@psykokwak4
Copy link
Contributor

The current documentation for generated APIs binds with core library. In YDK 0.4.1 documentation sidebar, we have cross referencing links between generated APIs and core library. We will lose connections if we generate documentation separately from core library. Current possible solutions are:

  • Host different landing pages for different version of YDK core libraries.
  • Manually maintain YDK landing pages and add links to newly generated bundle documentations.

We also need link in bundle documentation points back to core library documentation. Maybe we could add link in sidebar to corresponding YDK core library?
For instance, bundle ydk_cisco_ios_xr of version 0.1.0 uses core library version 0.4.1, then the YDK API in sidebar will link to http://ydk.cisco.com/py/docs/ydk.html?version=041. And we also have link in landing page http://ydk.cisco.com/py/docs?version=041 points to http://ydk.cisco.com/py/docs/bundles/cisco-ios-xr?version=010.

Any suggestions?

@ghost
Copy link

ghost commented Aug 16, 2016

screen shot 2016-08-16 at 9 43 21 am

@ghost ghost closed this as completed Aug 16, 2016
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant