Search Unity

  1. Looking for a job or to hire someone for a project? Check out the re-opened job forums.
    Dismiss Notice
  2. We are looking for your feedback about Templates! Tell us about your experiences by taking our survey.
    Dismiss Notice
  3. Good news ✨ We have more Unite Now videos available for you to watch on-demand! Come check them out and ask our experts any questions!
    Dismiss Notice

Custom Documentation Links

Discussion in 'Package Manager' started by JakHussain, May 24, 2019.

  1. JakHussain

    JakHussain

    Joined:
    Oct 20, 2016
    Posts:
    318
    I've got a package I'm hosting on a verdaccio server and I'm using Docfx to generate a static website on gitlab for my manual and scripting API. Everything works but I want to edit the package.json so that the documentation link in the package manager window sends users to my documentation site and not to Unity's documentation site. Is this possible / in the roadmap? I can't find any details on this.
     
  2. bdovaz

    bdovaz

    Joined:
    Dec 10, 2011
    Posts:
    827
    Same problem here.
     
  3. Erothez

    Erothez

    Joined:
    May 27, 2015
    Posts:
    20
    `PackageInfo.cs` implies that you can do offline documentation with `Documentation~` etc. but that's only the URI to .md files, with the URL redirect being hardcoded atm.

    The current workaround, as it uses `SearchOption.TopDirectoryOnly`, link to that .md file which then has a link to the rest of the online docs.

    An old comment seems to imply it used to be editable:

    Code (CSharp):
    1. // Module package.json files contain a documentation url embedded in the description.
    2. // We parse that to have the "View Documentation" button direct to it, instead of showing
    3. // the link in the description text.
    But seems this is only for builtin modules?
     
    Last edited: May 25, 2019
  4. phreezie

    phreezie

    Joined:
    Oct 3, 2019
    Posts:
    67
    Any news on this? There is
    changelogUrl
    and
    licensesUrl
    in package.json now, but still looking for a way to link to the documentation site of my package.
     
    yasirkula likes this.
  5. UnityMaru

    UnityMaru

    Community Engagement Manager Unity Technologies

    Joined:
    Mar 16, 2016
    Posts:
    949
    SugoiDev and yasirkula like this.
  6. phreezie

    phreezie

    Joined:
    Oct 3, 2019
    Posts:
    67
    Thanks, just found it out by trial and error a few days ago. Note there is also:
    • changelogUrl
      pointing to the, uh, changelog
    • licensesUrl
      for the licenses
    EDIT: Uh yeah I've already mentioned that in my post above. Sorry for the noise. ;)
     
    UnityMaru likes this.
unityunity