-
-
Notifications
You must be signed in to change notification settings - Fork 18
Description
We've already tackled explicitly specifying edit URLs for api docs (since they come from yml files across many repositories). But for guide contents, the link to edit is wrong just pointing back to the markdown files (ignoring that right now our doc site probably should be baking in the wiki urls until we switch over).
Specifically, it looks like the default theme uses relative page paths to build the URL, but our theme uses a path that typically begins with /
, and the URL built up contains two //
in succession, breaking the proper link URL.
For reference, the default plugin uses this.$page.relativePath
where we use this.$page.regularPath
: https://github.com/appcelerator/docs-devkit/blob/develop/packages/vuepress/vuepress-theme-titanium/components/PageEdit.vue#L69-L85
This doesn't seem to affect all pages, but some examples are:
- https://appcelerator.github.io/titanium-docs/guide/Quick_Start.html whose link for editing becomes https://github.com/appcelerator/titanium-docs/edit/master/docs//guide/Quick_Start.html
- https://appcelerator.github.io/titanium-docs/guide/Axway_Appcelerator_Studio/Axway_Appcelerator_Studio_FAQ.html pointing to https://github.com/appcelerator/titanium-docs/edit/master/docs//guide/Axway_Appcelerator_Studio/Axway_Appcelerator_Studio_FAQ.html
From what I can tell, the guide pages whose contents are a folder (i.e. https://appcelerator.github.io/titanium-docs/guide/Axway_Appcelerator_Studio/Axway_Appcelerator_Studio_Release_Notes/ ) end up generating correct edit URLs, but "leaf" pages do not.