[Bf-docboard] Add-on documentation in wiki or in manual ?

[Julian Eisel]

Hi,

Think it's fine to leave general pie usage documented in manual since
they are natively implemented in the source code. The pie menu add-on
is just a predefined and ready to use collection of pies. The Grease
Pencil uses pies even if the pie menu add-on is disabled.
However, we kinda abuse the Add-on system here a bit in that we use it
in place for a user preference option. Maybe we should add a UserPref
option for pie menus instead of having it as an Add-on. On top of
that, you could still have add-ons for custom pies (or eventually a
pie oven!). Thought of it before and it makes more and more sense to
me.

Notice this is kinda off-topic, sorry for that :)

Cheers,
- Julian -

On 5 November 2016 at 16:07, Gaia Clary <gaia.clary at machinimatrix.org> wrote:
> Hi, Tobias;
>
> Thanks for the feedback.
> However i suspect there is a misunderstanding here.
> I do not refer to documentation of individual Add-Ons.
>
> I refer to documentation about "Scripting in Blender":
>
> https://www.blender.org/manual/advanced/scripting/index.html
> https://wiki.blender.org/index.php/Dev:Py/Scripts
>
> cheers,
> Gaia
>
>
> On 05.11.2016 15:53, Tobias Heinke wrote:
>
> Hello Gaia,
>
> There's the policy that add-ons are not doc. in the manual.
>
> Add-ons currently in the manual:
>
> Cycles :)
>  Import/Export files (just a list)
>  Pie Menu (my fault)
>  Im-/export UV layout (on by default)
>
>  Groups: Official/community, On/off by default
>
> Still covered are official on by default add-ons.
> The reason I added pie menus was, because the  information about it in the
> wiki was scattered.
>
> The  reasons I see  not to add them:
>
> The manual already has over 1000 pages. (10 official on, 13 off, ~70
> community add-ons),
> Quality Assurance: the add-on author should be  responsible for doc. and
> maintenance.
> The wiki has personal pages, online editing.
>
> IMO the upgrade to the new wiki is the best solution.
> Or a separate repository for end user add-on documentation (probably
> impossible).
>
> Regards,
> Tobias
>
> Am 05.11.2016 um 13:03 schrieb Gaia Clary:
>
> hi.
>
> Yesterday i realized that we have Information about Add-ons on the
> wiki and in the blender manual. I believe this is not so cool because:
>
> - 2 places to be maintained and kept up to date
> - 2 places to point users to
>
> So what about migrating the addon related stuff from the wiki to the
> docs instead of improving the wiki pages? After all the manual
> meanwhile seems to be much better supported so it makes more fun
> to work there anyways (besides that it looks better)
>
> I am working on the wiki pages anyways at the moment so i could
> do the migration by cherry picking :)
>
> What do you think?
>
> cheers,
> Gaia
>
> _______________________________________________
> Bf-docboard mailing list
> Bf-docboard at blender.org
> https://lists.blender.org/mailman/listinfo/bf-docboard
>
>
>
>
> _______________________________________________
> Bf-docboard mailing list
> Bf-docboard at blender.org
> https://lists.blender.org/mailman/listinfo/bf-docboard
>
>
>
> _______________________________________________
> Bf-docboard mailing list
> Bf-docboard at blender.org
> https://lists.blender.org/mailman/listinfo/bf-docboard
>