Wow, this is great! I have a little free time, and have been a happy QS user way long enough to warrant sending something back, so I’ve made a start on the plugin docs import. I’ll open a ticket on GH to track.
Cheers, Josh > On 23 Nov 2017, at 10:44, Rob McBroom <[email protected]> wrote: > > Hello, everyone. > > I found a cool tool <http://www.mkdocs.org/> for dealing with documentation > and it inspired me to work on the manual. > > I consider it good enough to become the official manual now, so I’ve posted > it. > > https://qsapp.com/manual/ <https://qsapp.com/manual/> > Done so far: > > Import all the files from the GitHub wiki > Global search and replace for things like “OS X” > Update the Style Guide > Reformat tons and tons of things to match the style guide > Review, correct, add, and remove things from the Introduction section > Review, correct, add, and remove things from the Preferences section > I think there’s plenty more to do on the two sections I cleaned up, but for > the first time in years, the information is at least true, and some things > are documented for the first time! > > Still to do: > > Clean up the Features section > Clean up the Appendix section > Update existing screen shots and add many more > Break the intro and prefs sections into smaller pieces? They’re huge! > Somehow automate inclusion of the documentation > <http://projects.skurfer.com/QuicksilverPlug-inReference.mdown#documentation-and-bltrversion> > from each plug-in > Reconsider the scope of the features section now that plug-ins have > documentation (When the manual was created, they didn’t have any. Now they > do.) > Keep the thing updated! > I’m announcing it here because I’m done making massive changes that touch > every file. It should be safe for others to jump in and start helping. You > can find the files on GitHub. > > https://github.com/quicksilver/manual <https://github.com/quicksilver/manual> > I plan to keep working on it here and there, but I’d really like to see > others jump in. If it helps, think of it this way: Every minute I spend > working on the manual1 <x-msg://29/#fn:1> is a minute I’m not working on > fixing bugs and adding features. What do you want me spending my time on? 😉 > > Last but not least, I’d like to thank Howard Melman for all the work he did > creating the original manual. > > -- > Rob McBroom > http://www.skurfer.com/ <http://www.skurfer.com/> > Or answering basic questions in this group for that matter… hint ↩ > <x-msg://29/#fnref:1> > > -- > You received this message because you are subscribed to the Google Groups > "Quicksilver" group. > To unsubscribe from this group and stop receiving emails from it, send an > email to [email protected] > <mailto:[email protected]>. > To post to this group, send email to [email protected] > <mailto:[email protected]>. > Visit this group at https://groups.google.com/group/blacktree-quicksilver > <https://groups.google.com/group/blacktree-quicksilver>. > For more options, visit https://groups.google.com/d/optout > <https://groups.google.com/d/optout>. -- You received this message because you are subscribed to the Google Groups "Quicksilver" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To post to this group, send email to [email protected]. Visit this group at https://groups.google.com/group/blacktree-quicksilver. For more options, visit https://groups.google.com/d/optout.
