Jump to content

[TOPIC: topicViewTemplate]
[GLOBAL: userSmallPhoto]
Photo

Paid plugins: will current documentation template remain?
Started by tyrondis Oct 08 2016 09:55 AM

3 replies to this topic
plugins store paid documentation
[TOPIC CONTROLS]
[/TOPIC CONTROLS]
[modOptionsDropdown]
[/modOptionsDropdown]
[reputationFilter]
[TOPIC: post.html]
#1

tyrondis

[GLOBAL: userInfoPane.html]
tyrondis
  • Enthusiast

  • 55 posts
  • Corona SDK

With the upcoming Paid Plugins feature in the Corona Store, will this documentation process remain:

https://github.com/coronalabs/plugins-template-library-docs

 

I'd like to publish plugins as soon as this feature becomes available and I'd like to prepare my docs.

 

- Tyr



[TOPIC: post.html]
#2

Rob Miracle

[GLOBAL: userInfoPane.html]
Rob Miracle
  • Moderator

  • 26,394 posts
  • Enterprise

Yes that documentation is up to date. That said, many community plugin providers offer documentation from their own web servers.

 

Rob



[TOPIC: post.html]
#3

tyrondis

[GLOBAL: userInfoPane.html]
tyrondis
  • Enthusiast

  • 55 posts
  • Corona SDK

That means those templates are not a *most* to follow but rather a recommendation?



[TOPIC: post.html]
#4

Rob Miracle

[GLOBAL: userInfoPane.html]
Rob Miracle
  • Moderator

  • 26,394 posts
  • Enterprise

That's a hard question to answer. We provided the templates so you could use GitHub as an easy way to deploy documentation without you having to maintain your own website and write your own HTML. GitHub uses markdown so if you are going to use GitHub it should be written in markdown.

 

As for the templates themselves, you have to have a minimum level of documentation and the closer you adhere to the template the better it will be. The templates are designed based on our own documentation standards. But regardless all the information needs to be provided.

 

You have to have an:

 

  • Overview -- Let people know what it's about along with any gotchas, minimum requirements etc.
  • Configuration -- How do people need to include it in build.settings? What permissions do they need to add, etc?
  • List of all API calls and any values. Each of these needs their own separate entry.
  • Samples -- show people how to use it.
  • Contact info 
  • valid platforms for the plugin.

 

The closer you can match what we list the better it will be.  Consider it a minimum requirements but you don't have to use github and markdown.

 

Rob




[topic_controls]
[/topic_controls]

Also tagged with one or more of these keywords: plugins, store, paid, documentation