1. Welcome to skUnity!

    Welcome to skUnity! This is a forum where members of the Skript community can communicate and interact. Skript Resource Creators can post their Resources for all to see and use.

    If you haven't done so already, feel free to join our official Discord server to expand your level of interaction with the comminuty!

    Now, what are you waiting for? Join the community now!

Dismiss Notice
This site uses cookies. By continuing to use this site, you are agreeing to our use of cookies. Learn More.

[Feedback Requested] Docs data updates

Discussion in 'Suggestions and Feedback' started by BaeFell, Mar 4, 2018.

  1. BaeFell

    BaeFell I'm Poppy
    Admin

    Joined:
    Nov 27, 2016
    Messages:
    834
    Likes Received:
    226
    Hi everyone,

    An idea proposed by @Nicofisi is to update the docs data. Things such as the titles, descriptions, examples and declaring syntax/addons as deprecated.

    I have always said no to modifying the docs data as it's user submitted and is controlled by the addon developer, however, Nicofisi made a good case about how searching is affected by titles being different formats depending on the addon. Because of this - I am asking for feedback from the community at what point it is acceptable for us as staff to get involved with the docs data and edit it.

    All feedback is welcome and appreciated.

    Thanks,
    BaeFell
     
  2. Pikachu

    Moderator Supporter Addon Developer

    Joined:
    Jan 25, 2017
    Messages:
    871
    Likes Received:
    139
    Medals:
    It is always acceptable for staff to edit doc elements for the benefit of the docs. I don't see why it wouldn't be.
     
    • Agree Agree x 1
  3. BaeFell

    BaeFell I'm Poppy
    Admin

    Joined:
    Nov 27, 2016
    Messages:
    834
    Likes Received:
    226
    I have always thought of it better to suggest to the addon developer to do something than force it upon them.
     
    • Friendly Friendly x 1
  4. Pikachu

    Moderator Supporter Addon Developer

    Joined:
    Jan 25, 2017
    Messages:
    871
    Likes Received:
    139
    Medals:
    maybe this was a good idea in the past, but in modern skript times where half the addons on the docs are abandoned it just doesn't work anymore. In addition, I couldn't name a single addon dev who wouldn't be happy if someone improved their docs.
     
    • Agree Agree x 1
  5. BaeFell

    BaeFell I'm Poppy
    Admin

    Joined:
    Nov 27, 2016
    Messages:
    834
    Likes Received:
    226
    That's what my recent thoughts have been. I've realised a lot of content on the docs is extremely outdated or just not at a good standard. Documenting Skript addons has always been a boring thing to do as I remember doing it myself when skUnity first launched. I do believe this might be a good change to employ.
     
    • Like Like x 1

Share This Page

Loading...