Set up Docs

[benlk]

https://docs.readthedocs.org/en/latest/getting_started.html#import-your-docs

[benlk]

Changing this to "Set up docs" in general, because I'm going to use plain GitHub presentation of Markdown in the https://github.com/INN/super-cool-ad-inserter-plugin/tree/docs-as-markdown branch.

[aschweigert]

Let's focus on getting some basic docs in place first and we can always improve later. We'll be setting this up for the first couple of sites so it's fine if the docs are just a shell and I'm not worried about getting them on read the docs just yet. Just a simple readme is totally ok given our current time crunch.

[benlk]

Yep, docs will be a shell. Priority is "how do I make a shortcode work", with paste-able example code.

[benlk]

Basic docs are here: https://github.com/INN/super-cool-ad-inserter-plugin/tree/master/docs

[benlk]

• [ ] full explanation of shortcodes
  • default automatically-inserted [scaip number=2]
  • [scaip no]
  • [scaip] without arguments
  • link to developer documents for making new shortcodes
• [ ] How to prevent automatic shortcode addition
  • meta checkbox
  • [scaip no] is less preferred

[aschweigert]

ok to close?

[benlk]

I think so.