Re: a new manual

[Rob McBroom]

On 27 Mar 2018, at 6:19, Josh wrote:

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.


Cool! I’ll keep the detailed comments [over 
there](https://github.com/quicksilver/manual/issues/1).


--
Rob McBroom
http://www.skurfer.com/

--
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 blacktree-quicksilver+unsubscr...@googlegroups.com.
To post to this group, send email to blacktree-quicksilver@googlegroups.com.
Visit this group at https://groups.google.com/group/blacktree-quicksilver.
For more options, visit https://groups.google.com/d/optout.

Re: a new manual

[Josh]

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  wrote:
> 
> Hello, everyone.
> 
> I found a cool tool  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/ 
> 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 
> 
>  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 
> 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  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/ 
> Or answering basic questions in this group for that matter… hint ↩ 
> 
> 
> -- 
> 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 blacktree-quicksilver+unsubscr...@googlegroups.com 
> .
> To post to this group, send email to blacktree-quicksilver@googlegroups.com 
> .
> Visit this group at https://groups.google.com/group/blacktree-quicksilver 
> .
> For more options, visit 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 blacktree-quicksilver+unsubscr...@googlegroups.com.
To post to this group, send email to blacktree-quicksilver@googlegroups.com.
Visit this group at https://groups.google.com/group/blacktree-quicksilver.
For more options, visit https://groups.google.com/d/optout.

Re: a new manual

[Patrick Robertson]

Amazing job Rob! I'd say in order to push more people to contribute, we
should add a paragraph in the 'Home' page (and potentially in the footer?)
explaining how to go in and edit the documentation.

I'd also say let's re-jig https://qsapp.com/support.php and put the manual
at the top (along with a link on how to edit). The wiki is kind of obsolete
now. Could we look at moving the contents from there into the manual?

On 27 November 2017 at 22:36, Rob McBroom  wrote:

> On 26 Nov 2017, at 11:39, 1.61803 wrote:
>
> On Thursday, November 23, 2017 at 3:44:36 AM UTC+1, Rob McBroom wrote:
>>
>>>
>>> https://qsapp.com/manual/
>>>
>>>
>> Will a PDF version be available? See mkdocs' #374 for third-party
>> solutions and current state of plugin API. Gitprint could be an alternative
>> too.
>>
>
> I have no plans to create or maintain a PDF version myself, but others are
> welcome to.
>
> --
> Rob McBroom
> http://www.skurfer.com/
>
> --
> 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 blacktree-quicksilver+unsubscr...@googlegroups.com.
> To post to this group, send email to blacktree-quicksilver@googlegr
> oups.com.
> Visit this group at https://groups.google.com/group/blacktree-quicksilver.
> For more options, visit 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 blacktree-quicksilver+unsubscr...@googlegroups.com.
To post to this group, send email to blacktree-quicksilver@googlegroups.com.
Visit this group at https://groups.google.com/group/blacktree-quicksilver.
For more options, visit https://groups.google.com/d/optout.

Re: a new manual

[Rob McBroom]

On 26 Nov 2017, at 11:39, 1.61803 wrote:


On Thursday, November 23, 2017 at 3:44:36 AM UTC+1, Rob McBroom wrote:


https://qsapp.com/manual/



Will a PDF version be available? See mkdocs' #374 for third-party 
solutions and current state of plugin API. Gitprint could be an 
alternative too.


I have no plans to create or maintain a PDF version myself, but others 
are welcome to.


--
Rob McBroom
http://www.skurfer.com/

--
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 blacktree-quicksilver+unsubscr...@googlegroups.com.
To post to this group, send email to blacktree-quicksilver@googlegroups.com.
Visit this group at https://groups.google.com/group/blacktree-quicksilver.
For more options, visit https://groups.google.com/d/optout.

Re: a new manual

[1.61803]

On Thursday, November 23, 2017 at 3:44:36 AM UTC+1, Rob McBroom wrote:
>
> https://qsapp.com/manual/
>

Will a PDF version be available? See mkdocs' #374 
 for third-party solutions and 
current state of plugin API. Gitprint  could be an 
alternative too.

-- 
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 blacktree-quicksilver+unsubscr...@googlegroups.com.
To post to this group, send email to blacktree-quicksilver@googlegroups.com.
Visit this group at https://groups.google.com/group/blacktree-quicksilver.
For more options, visit https://groups.google.com/d/optout.