1. These forums are being retired. Please ask all questions and help threads and any other type of discussions on GitHub. During this time, new threads and user registrations have been disabled.

New location for documentation

Discussion in 'Community News' started by nicatronTg, Nov 17, 2016.

  1. nicatronTg

    nicatronTg Shank / hakusaro
    TShock Founder TShock Admin

    Jul 21, 2011
    We've migrated away from the wiki for documentation. We're now using ReadMe.io with a generously provided open source license. The new docs can be found at tshock.readme.io and in the navigation bar at the top of the page. The old docs have been retired, and the wiki will eventually be removed.

    There are some really neat benefits from using ReadMe. Right now, we have the documentation for the current version of TShock on there. However, in the top right hand corner, you'll eventually be able to change documentation versions depending on which version you're running. This means that we can update our documentation with each version, and you'll always have the historical record of what changed.

    Moving to ReadMe is still a work in progress, especially when it comes to the REST documentation. We're working on that. However, we'd like to extend our thanks to everyone who helped move documentation over. In particular, @Da Bomber played a critical role in helping with the move. Without his help, we wouldn't be using ReadMe right now.

    As always, we accept suggestions on any documentation pages. You can "suggest edits" on any page, and send us general feedback on here, on Slack, or on Twitter.
    • Like Like x 5
    • Informative Informative x 1
    • Friendly Friendly x 1
  2. bippity

    Plugin Developer

    Jan 14, 2012
    • Funny Funny x 1
  3. cccdfern

    cccdfern Level 4

    Apr 17, 2012
    Looks great and reads well, good job.
    • Agree Agree x 1