plugin:OpenWikiPage does not respect Creator Docs

Reproduction Steps

  1. Create a new plugin

  2. In the plugin script, use plugin:OpenWikiPage(“API:Class/BasePart”)

  3. When running this, it opens to the old docs and gives a 404.

Expected Behavior

Should open to the creator docs or at least redirect correctly.

Actual Behavior

Upon opening a wiki page window, you get a 404 page.

Issue Area: Studio
Issue Type: Other
Impact: High
Frequency: Constantly

What’s your use case for this?

The information architectures of the old site vs the new site are completely different, so simply swapping out the base URL will not make old links work.

I imagine deprecating this method is the most sensible course of action. It comes from a time when it linked to the actual user editable wiki so you could link to user editable pages. Without that capability I don’t see what purpose it could still serve.

1 Like

Well my main use case is being able to easily open a new window for the creator docs and display documentation info on an item. I have a plugin that builds documentation based off the script itself or input and I wanted to make it intelligent and know if the item is a class, and then link it when a button is pressed. I did not know that it used to link to the old wiki, and a new method called plugin:OpenDocsPage would probably be better for long term. I know I am probably the only person who would want to use it but it will help out my workflow extremely in the long term.

Unfortunately I think this is a wontfix.

We don’t make any guarantees about the structure of the create site staying exactly the same, and since you pass an opaque URI to the API it’s fundamentally prone to breaking when the information architecture changes.

I would make a feature request for what you actually want instead.

This topic was automatically closed 14 days after the last reply. New replies are no longer allowed.