Having a clear, exhaustive and user-friendly documentation is one of the core goals of the Smoothie project.
We have put a lot of work into what we have now, and we get quite a bit of praise for it.
We are also currently working on producing video documentation, though that’s a long-term goal.
But nothing is perfect.
I’ve recently been working on improving the documentation further, and I think I have a hard time putting myself in my shoes of the “average” user sometimes. I know where everything is and what everything means.
The thing is new users don’t.
What do you think could be improved ?
What did you search and not find ?
What was not clear enough ?
Do you have ideas of how to structure some things better ? Add pointers in some places ?
Are some things too cryptic or too advanced ? Are some not enough ?
If you take just a few minutes to give feedback on your experience with the Smoothie wiki ( http://smoothieware.org ) and your ideas on how to improve it, you will be helping to improve the documentation, and making the life of new users easier.
I can’t promise I will fulfill everyone’s wishes or implement everyone’s ideas, but your comments will definitely help push the documentation in the right direction and make things better.
I think that the documentation is very good, it can be slightly daunting if you skim read it.
The one benefit that could have been useful to me when i was building my printer, was specific examples for some of the more advanced features. For example, i was trying to implement Delta Grid on my Cartesian printer, i was having a hard time finding about how to define the centre of the bed (this example has now been added and is very useful).
Also, maybe if adjustments are needed in any slicing software etc. Again back to the Delta Grid on Cartesian, i had to alter my min, max and bed centre settings to match the firmware but to some people this might not be clear.
Yes, the delta grid example is something several users have asked for when I started asking around for what to improve.
About slicer settings, I’m not sure exactly how to describe them as there are at least 4 major slicing software, and I’m only vaguely familiar with one of them. Would you have a screenshot of the specific settings you have to change for me ?
Apologies, i did not mean that there should be examples for each slicing software, simply that your slicer settings should match your config settings, in terms of Min / Max positions etc.
I’m configuring my second smoothie machine. First was a delta printer I built a year and a half ago, now using one to retrofit a cnc router from the '90’s. Obviously without the wiki I’d be lost, so the fact I had success on the first machine enough to use it on another says the information is there waiting be found. I do find it tedious to navigate around to find the little quirks (keep this out of the config if doing this, cannot do x if using pin ## for y….). My current effort is trying to get an Ic2 panel to work through an arduino and I’m not having much luck…yet.
I think the main help I’d like to see implemented is a complete listing of config commands with options and explanation. This would be similar to the page listing the g-codes. It could be in a single large table on one page of the wiki. The default config file does this quite well with the commented explanations for entries where you need to enter a numerical value however when a text value is required you need to chase around to find the potential options. examples: thermister options, panel options, machine types (delta, core x-y, etc). With panel variables for instance, some only apply to certain panels. It would be great if every possible variable were listed and the comment could list the exceptions where that variable is not compatible. If this were maintained as new features are added to the firmware it would be much easier to take advantage of them.
You’ve done a great job with the newer graphics labeling the headers. A supplemental table listing every pin and their default assignments would be nice. The table would help identify what pins are free for external i/o and which ones are already consumed by on-board functions. This could also be a commented “table” included at the top of the config file listing each pin along with it’s default assignment. The table could also note the capabilities, pwm, etc., of each pin.
My current effort is trying to get an Ic2 panel to work through an arduino and I’m not having much luck…yet.
Unfortunately that was added to the firmware but never documented yes. And I have no idea how it works so I can’t add it to the wiki.
If you ever figure it out, please email me at wolf.arthur@gmail.com with the instructions that worked for you so I can add it to the wiki.
Btw, I believe a few users on the Smoothie irc channel have gotten this to work, so hanging on IRC and asking about it on a regular basis would probably get you somewhere.
I think the main help I’d like to see implemented is a complete listing of config commands with options and explanation.
We have that : http://smoothieware.org/configuration-options
For details ( like “what values apply to what panel” etc ), you need to look at that specific panel’s documentation though.
I do agree some information is missing, we are going to try to add it as best as we can. Don’t hesitate to do it yourself wherever you realize you know more than the wiki is saying.
The table would help identify what pins are free for external i/o and which ones are already consumed by on-board functions.
That’s fairly difficult to do because that depends a lot on the exact setup, but I’ll try to improve this.