From 9cef98943e85bd6b93792c2db1bc3b3e964971b5 Mon Sep 17 00:00:00 2001 From: Andy Meneely Date: Wed, 3 Feb 2016 12:56:14 -0500 Subject: [PATCH] docs: porting help and other tweaks --- docs/help.rst | 40 ++++++++++++++++++++++++++++++++++++++++ docs/index.rst | 1 + docs/learning.rst | 2 -- 3 files changed, 41 insertions(+), 2 deletions(-) create mode 100644 docs/help.rst diff --git a/docs/help.rst b/docs/help.rst new file mode 100644 index 0000000..3a0901c --- /dev/null +++ b/docs/help.rst @@ -0,0 +1,40 @@ +Get Help and Give Help +====================== + +Get Help +-------- + +Squib is powerful and customizablem, which means it can get complicated pretty quickly. Don't settle for being stuck. + +Here's an ordered list of how to find help: + +1. Go through this documentation +2. Go through `the wiki `_ +4. Google it - people have asked lots of questions about Squib already in many forums. +5. Ask on Stackoverflow `using the tags "ruby" and "squib" `_. You will get answers quickly from Ruby programmers it's and a great way for us to archive questions for future Squibbers. +6. Our `thread on BoardGameGeek `_ is quite active and informal (if a bit unstructured). + +If you email me directly I'll probably ask you to post your question publicly so we can document answers for future Googling Squibbers. + +Please use GitHub issues for bugs and feature requests. + +Help by Troubleshooting +----------------------- + +One of the best ways you can help the Squib community is to be active on the above forums. Help people out. Answer questions. Share your code. Most of those forums have a "subscribe" feature. + +You can also watch the project on GitHub, which means you get notified when new bugs and features are entered. + +Help by Beta Testing +-------------------- + +TODO: Write this up + + +Help by Fixing Bugs +------------------- + +A great way to make yourself known in the community is to go over `our backlog `_ and work on fixing bugs. Even suggestions on troubleshooting what's going on (e.g. trying it out on different OS versions) can be a big help. + +If you have code to contribute, see our diff --git a/docs/index.rst b/docs/index.rst index 4833099..e6717a0 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -14,6 +14,7 @@ Contents: layouts units colors + get_help dsl/index.rst Indices and tables diff --git a/docs/learning.rst b/docs/learning.rst index 2147f77..23f81b4 100644 --- a/docs/learning.rst +++ b/docs/learning.rst @@ -1,8 +1,6 @@ Learning Squib ============== -Here is some stuff: - .. toctree:: :maxdepth: 1