Search Unity

[Request] Switch Documentation site to DocFX like Package docs

Discussion in 'Documentation' started by xCyborg, May 18, 2018.

  1. xCyborg

    xCyborg

    Joined:
    Oct 4, 2010
    Posts:
    513
    I wrote previously to try to bring attention to some of the docs layout and content issues, nothing really changed, especially the API docs, the left panel is broken and content is missing.
    The new package API docs by DocFX fixes a lot of these issues, plus many features as well.
    Please consider migrating Unity documentation to this or at least give option to view it by this doc generator.

    https://docs.unity3d.com/Packages/c...yEngine.Experimental.Rendering.CoreUtils.html
     
    MMOARgames likes this.
  2. xCyborg

    xCyborg

    Joined:
    Oct 4, 2010
    Posts:
    513
    Bumpity Bump!
     
  3. asperatology

    asperatology

    Joined:
    Mar 10, 2015
    Posts:
    966
    It sounds like it would take wayyyy too much effort for this, but I don't know what the official stance is in regards to improving documentation.
     
  4. MMOARgames

    MMOARgames

    Joined:
    Feb 28, 2013
    Posts:
    24
    xCyborg likes this.
  5. xCyborg

    xCyborg

    Joined:
    Oct 4, 2010
    Posts:
    513
  6. StephenHodgson-Valorem

    StephenHodgson-Valorem

    Joined:
    Mar 8, 2017
    Posts:
    148
    Wasn't too hard. Just forked the UnityCSReference github, installed docfx, setup the project, and exported the website into the docs folder. Then after I merged that into master, I enabled GitHub pages.
     
    Last edited: Jan 23, 2019
    rlevreault and xCyborg like this.
  7. rlevreault

    rlevreault

    Unity Technologies

    Joined:
    Apr 12, 2017
    Posts:
    2
    Nice job, Stephen. I shared your work with the rest of the doc team.
     
  8. StephenHodgson-Valorem

    StephenHodgson-Valorem

    Joined:
    Mar 8, 2017
    Posts:
    148
  9. xCyborg

    xCyborg

    Joined:
    Oct 4, 2010
    Posts:
    513
    Yep. It'd be awesome if they take it on, still need the description bits, which should also be open-sourced somehow (like summery comments), maybe even take pull requests from the community.
     
  10. StephenHodgson-Valorem

    StephenHodgson-Valorem

    Joined:
    Mar 8, 2017
    Posts:
    148
    I haven't seen unity push an update to the cs reference in 3 months. I hope everything is okay.