Update plug-in API docs to follow MDN format #699
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updates the plug-in API docs to follow a structure similar to that used on MDN. Roughly speaking, that means showing the syntax, briefly outlining the different properties and methods, then expanding below with examples, finishing off with links to related content.
In part, this should help address #652. Further changes will be needed in other parts of the documentation, but this is a good start.
Plan is to:
Indiekit.addEndpoint
Indiekit.addPreset
Indiekit.addStore
Indiekit.addSyndicator
IndiekitError