[WIP] Bullethole - Theme Documentation [v2]

Discussion in 'Mafia' started by TheUnknownOne, Oct 5, 2013.

Moderators: Pamitha, Water
  1. TheUnknownOne

    TheUnknownOne Member

    Joined:
    Mar 28, 2011
    Messages:
    988
    Likes Received:
    3
    Check it out here. Source code here. JavaScript is required.
    Supported browsers (in order of priority): Chrome [latest], Firefox [latest], IE 10+, IE 9, Opera [12.x latest, latest], Safari 6+ (other browsers might work too)

    Bullethole is a second attempt at a good theme documentation. This time though, it has a simple UI, inline examples, a search box, and (soon) other features.

    It currently has all the documentation from the old wiki page. Unfortunately, it doesn't have the most up-to-date information (or really any of the new features), so if anyone wants to help me out, that'll be great. :)

    The documentation files that it uses is available in 4 flavors, if you're interested in that:

    If the page doesn't render right, or something doesn't show, try Ctrl/Command + R or Ctrl/Command + Shift + R. Keep in mind that this is a WIP, it might be broken from time to time.

    Found a bug, inaccurate information/correction, or have a suggestion? Feel free to let me know. If you want, you can even fork the repo and edit it yourself!
     
    Last edited: Dec 6, 2013
  2. IceKirby

    IceKirby A.K.A. RiceKirby

    Joined:
    Apr 26, 2011
    Messages:
    2,176
    Likes Received:
    635
    PO Trainer Name:
    RiceKirby
    Oh, cool.
    Suggestion: expand/collapse the details for a property by clicking anywhere in the name (instead of only in the Arrow).

    Also, if I wanted to send a pull request to the documentation, which file should I edit?
     
  3. TheUnknownOne

    TheUnknownOne Member

    Joined:
    Mar 28, 2011
    Messages:
    988
    Likes Received:
    3
    Added, thanks :)

    You're looking for data/docs.coffee. You can run the grunt task if you want, I won't mind if you don't though.
    The syntax is pretty straightforward, and everything that is parsed by the JavaScript is somewhere in the file.
     
    Last edited: Oct 7, 2013
  4. TheUnknownOne

    TheUnknownOne Member

    Joined:
    Mar 28, 2011
    Messages:
    988
    Likes Received:
    3
    Added a search feature to the sidebar for quick navigation, along with a few other improvements such as category summaries being hidden by default.
     
  5. Fuzzysqurl

    Fuzzysqurl baa baa mareep I do what I want Server Owner Developer I do what I want Server Owner Developer

    Joined:
    Sep 12, 2012
    Messages:
    2,096
    Likes Received:
    967
    Sides.sides and Sides.translation are required. They are marked as optional. Otherwise, this looks like an amazing start to a useful tool. It combines How to Make with Documentation
     
  6. TheUnknownOne

    TheUnknownOne Member

    Joined:
    Mar 28, 2011
    Messages:
    988
    Likes Received:
    3
    Oops, silly mistake from me. Thanks though!

    Edit: Role documentation added, a few UI improvements here and there.
     
    Last edited: Oct 6, 2013
  7. Fuzzysqurl

    Fuzzysqurl baa baa mareep I do what I want Server Owner Developer I do what I want Server Owner Developer

    Joined:
    Sep 12, 2012
    Messages:
    2,096
    Likes Received:
    967
    I know I'm going to mess it up so I'm not even gonna try at this point, but I expanded on the "hide" attribute for Roles awhile ago, it can now be one of 5 options. Not sure if you wanna just throw out the boolean part and just say its a string or if you want to include all the options.

    true, false, "side", "role", "both"

    true = Hides from /sides and /roles
    "both" = same as true
    "side" = Hides from /sides (Info would be needed for this)
    "role" = Hides from /roles (Info would not be needed for this)
    false = no hiding
     
  8. TheUnknownOne

    TheUnknownOne Member

    Joined:
    Mar 28, 2011
    Messages:
    988
    Likes Received:
    3
    Fixed, thanks.

    The documentation is now hosted at bullethole.github.io, and there's an organization now. If you're interested in being a collaborator, send me a PM.
     
  9. TheUnknownOne

    TheUnknownOne Member

    Joined:
    Mar 28, 2011
    Messages:
    988
    Likes Received:
    3
    I've added everything that was in the 'Action' section of the old documentation.

    If someone could tell me what exactly is new, that'd be great.
     
  10. TheUnknownOne

    TheUnknownOne Member

    Joined:
    Mar 28, 2011
    Messages:
    988
    Likes Received:
    3
    Added standby actions. I'm hoping to port night actions this week.

    Not many examples just yet, if anyone thinks an example for property xxx would be useful, you can let me know and I'll implement it.
     
  11. TheUnknownOne

    TheUnknownOne Member

    Joined:
    Mar 28, 2011
    Messages:
    988
    Likes Received:
    3
    Finally got around to adding night actions! The documentation on the wiki is now obsolete.

    All that really needs to be done is the new stuff, still haven't got anyone who wants to help me with that :(
     
Moderators: Pamitha, Water