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.

Official [Feedback] What do YOU want in Docs 2?

Discussion in 'Suggestions and Feedback' started by BaeFell, Apr 17, 2017.

  1. BaeFell

    BaeFell I'm Poppy
    Admin

    Joined:
    Nov 28, 2016
    Messages:
    273
    Likes Received:
    162
    Hi everyone,

    skUnity Docs 2 are nearing release. I'm finishing up some features and making everything as smooth as possible. Before launching though, I want to see what you would like to see in Docs 2. My current mindset about features are ones that are essential to Docs and will be included before launch and other features which will come shortly after launch.

    This thread basically serves as a place for you to say what you'd like to see, what didn't work well, what did work well and just general discussion about the Docs. All feedback is appreciated, but please keep it on-topic and constructive. Not all features will be added, but I'll be sure to consider every suggestion.

    Thanks,
    BaeFell
     
    • Like Like x 8
  2. aescraft

    aescraft Well-Known Member

    Joined:
    Mar 1, 2017
    Messages:
    237
    Likes Received:
    13
    A tab for example discussion would be nice.
     
    • Agree Agree x 3
    • Like Like x 1
  3. BaeFell

    BaeFell I'm Poppy
    Admin

    Joined:
    Nov 28, 2016
    Messages:
    273
    Likes Received:
    162
    Examples will be on a voting system. You'll be able to upvote and downvote examples. The votes each example has then affects where it's displayed on the list. While there isn't a comment system, I could look into it, but not sure of its use.
     
    • Informative Informative x 3
    • Useful Useful x 1
  4. Gatt

    Gatt Ruler
    Moderator Addon Developer Supporter

    Joined:
    Dec 8, 2016
    Messages:
    143
    Likes Received:
    21
    The ability to include images to show what will happen in game.
     
    • Like Like x 1
  5. BaeFell

    BaeFell I'm Poppy
    Admin

    Joined:
    Nov 28, 2016
    Messages:
    273
    Likes Received:
    162
    Just gifs or multiple images?
     
    • Like Like x 1
  6. BrettPlayMC

    BrettPlayMC Member

    Joined:
    Jan 26, 2017
    Messages:
    511
    Likes Received:
    36
    I would suggest just image links so the images don't spam up the page. I also think that there should be a reviewal system for examples so someone can't spam them.
     
  7. BaeFell

    BaeFell I'm Poppy
    Admin

    Joined:
    Nov 28, 2016
    Messages:
    273
    Likes Received:
    162
    It'd probably just be a button like "See in action". Examples in Docs 1.0 are reviewed by the addon author. In Docs 2, they're not reviewed and rely on community moderating. However, there will be an Activity Queue where we as staff can view and the addon author themselves can see.
     
    • Like Like x 1
    • Agree Agree x 1
  8. WheezyGold7931

    WheezyGold7931 BaeFell Enthusiast
    Supporter VIP+

    Joined:
    Jan 26, 2017
    Messages:
    89
    Likes Received:
    30
    Medals:
    Add skript apis to the docs. So like Rezz's json.sk's syntax can be added into the docs so users can easily search it.
     
    • Agree Agree x 4
  9. BaeFell

    BaeFell I'm Poppy
    Admin

    Joined:
    Nov 28, 2016
    Messages:
    273
    Likes Received:
    162
    Completely forgot about those! That'll be a thing I'll look at adding. Wrong did a majority the public side, so I'll have to have a play around. Shouldn't be too difficult.
     
  10. WheezyGold7931

    WheezyGold7931 BaeFell Enthusiast
    Supporter VIP+

    Joined:
    Jan 26, 2017
    Messages:
    89
    Likes Received:
    30
    Medals:
    Also I know this is sort of off topic but it sorta is still on topic, you should make a Syntax Add-on that lets you make custom syntax within skript
    --- Double Post Merged, Apr 17, 2017, Original Post Date: Apr 17, 2017 ---
    So we don't need to use functions
     
  11. Polymeth

    Polymeth Member

    Joined:
    Apr 16, 2017
    Messages:
    3
    Likes Received:
    2
    APIs and even snippets / algorithms. Could be very useful !
     
    • Agree Agree x 1
  12. Adrihun

    Adrihun Member

    Joined:
    Feb 1, 2017
    Messages:
    362
    Likes Received:
    5
    Maybe comments on examples?

    @WheezyGold7931 Can you fix server selector
     
  13. Bilbo

    Bilbo Active Member

    Joined:
    Jan 26, 2017
    Messages:
    27
    Likes Received:
    0
    @BaeFell I dont really think this is really on topic, i am new to SkUnity, but for the very best i hope the new Doc's will have smaller, not usually used things, like banner commands, that are explained as well, Things of that sort that are basically on some specific documents explained at addon creators page, BUT for a new beginner on Skript, those are really hard to understand at all, so i might suggest taking a look at Skript Help page on the forum and make sure the most popular question answers could be found there.

    Another thing is implementing and Q: // A: on the .docs, why? and from what? - i would say the same thing it would read the post from Skript help and post the Skript help posts + the Best answer to there, when a best answer is chosen, just so while you are looking for things, you might just go to the side bar and check the newest things that where answered. I personally check them manually, but that could be a future thing you might maybe implement.

    Sorry, if i misunderstood the post. In that case, forget what i said.
     
  14. BaeFell

    BaeFell I'm Poppy
    Admin

    Joined:
    Nov 28, 2016
    Messages:
    273
    Likes Received:
    162
    Both of your suggestions sound better suited for the forums than the docs. The docs are intended as just a location to find syntax and the different features of addons. I'll look into seeing about being to put as much information as possible for each syntax element to help new Skripters, but the forums will be the best source if you really need help. There is also the skUnity Discord (link at the bottom of the forums) which has dedicated channels for help. Hope this clears things up for you :emoji_slight_smile:
     
    • Like Like x 1
  15. Tlatoani

    Addon Developer

    Joined:
    Jan 24, 2017
    Messages:
    114
    Likes Received:
    26
    Medals:
    For events, a little tab or something to include/explain the event-values for each event.
     
    • Agree Agree x 8
    • Like Like x 1
  16. Adrihun

    Adrihun Member

    Joined:
    Feb 1, 2017
    Messages:
    362
    Likes Received:
    5
    Fix the downloads first in the skUnity downloads page. some addons like skDragon just take you to a page that doesn't exist.
     
    • Agree Agree x 3
  17. Jordan

    Jordan Member

    Joined:
    Jan 25, 2017
    Messages:
    157
    Likes Received:
    12
    Better search algorithm.
     
    • Agree Agree x 4
  18. BaeFell

    BaeFell I'm Poppy
    Admin

    Joined:
    Nov 28, 2016
    Messages:
    273
    Likes Received:
    162
    Added :emoji_slight_smile:

    That's the authors responsibility, not ours. Majority of addons on skUnity Docs, exist on in the resources section of the forums.

    Will be looking at trying to improve this massively, including an advanced search feature.
     
    • Like Like x 1
  19. Adrihun

    Adrihun Member

    Joined:
    Feb 1, 2017
    Messages:
    362
    Likes Received:
    5
    Do more examples because a lot of them say "+ ADD EXAMPLE" and also do more Descriptions, some of them say "+ Add description!"
    --- Double Post Merged, Apr 17, 2017, Original Post Date: Apr 17, 2017 ---
    Good idea!
     
  20. BaeFell

    BaeFell I'm Poppy
    Admin

    Joined:
    Nov 28, 2016
    Messages:
    273
    Likes Received:
    162
    Again, up to the addon author. There will be tools to quickly list syntax elements without an example and add one as a general docs user which should hopefully encourage community contributions.
     
Loading...
  • About Us

    Our community has been around for many years and pride ourselves on offering unbiased, critical discussion among people of all different backgrounds. We are working every day to make sure our community is one of the best.
  • Support skUnity

    The staff team works very hard to make sure the community is running its best. This means constantly performing upgrades to systems and other features. This does cost a bit of money to keep doing. Donating to skUnity would allow the server to keep running smoothly for years to come!

    Support Us!
  • Join Our Discord

    Discord is an all-in-one voice and text chat for gamers that’s free, secure, and works on both your desktop and phone.