Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update plug-in API docs to follow MDN format #699

Merged
merged 6 commits into from
Feb 27, 2024
Merged

Conversation

paulrobertlloyd
Copy link
Collaborator

@paulrobertlloyd paulrobertlloyd commented Feb 26, 2024

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:

  • update API docs for Indiekit.addEndpoint
  • update API docs for Indiekit.addPreset
  • update API docs for Indiekit.addStore
  • update API docs for Indiekit.addSyndicator
  • update API docs for IndiekitError
  • update references to use new post type concept

@paulrobertlloyd paulrobertlloyd merged commit 2381fb7 into main Feb 27, 2024
@paulrobertlloyd paulrobertlloyd deleted the docs/mdn-format branch February 27, 2024 21:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant