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 documentation #21

Open
1 of 2 tasks
joeguilmette opened this issue Sep 9, 2018 · 11 comments
Open
1 of 2 tasks

Update documentation #21

joeguilmette opened this issue Sep 9, 2018 · 11 comments
Assignees

Comments

@joeguilmette
Copy link
Member

joeguilmette commented Sep 9, 2018

  • Update the readme in this repo to point to the add-on API docs
  • Update the add-on API docs to describe new functionality
@joeguilmette
Copy link
Member Author

Hey @mbissett what is the status on this?

@mbissett
Copy link
Contributor

mbissett commented Oct 15, 2018

Nothing yet, I've been either focusing on the other docs task or support. Like the other task (Bulk WPML Edit), though, I can put some focus on this if desired.

@mbissett
Copy link
Contributor

I've responded on the Bulk WPML Edit task with my findings, I'll put some time in on this now.

@mbissett
Copy link
Contributor

What did you have in mind for updating the docs to mention new functionality? Are you referring to adding new field types, the functions for Step 1, that sort of thing?

Or something else?

@joeguilmette
Copy link
Member Author

Are you referring to adding new field types, the functions for Step 1, that sort of thing?

Yes, all the new field types/options we've added that aren't currently documented.

@joeguilmette
Copy link
Member Author

This is a lower priority than the other Docs project.

@mbissett
Copy link
Contributor

@joeguilmette, new question: Are these docs meant for the new site now, or do you want them on GitHub?

@joeguilmette
Copy link
Member Author

You can put them in GitHub.

@mbissett
Copy link
Contributor

mbissett commented Jan 8, 2019

@joeguilmette I've got some new files in the "new_docs" branch, but it's somewhat sparse right now (I added what didn't already exist here).

Would you want a reference like our extended API reference here: https://github.com/soflyy/wp-all-import-action-reference - or should I still continue with the idea to have only the undocumented stuff listed?

@joeguilmette
Copy link
Member Author

My apologies, I made a mistake. Please update our existing add-on API docs on
http://www.wpallimport.com/documentation/addon-dev/overview/ so that it is up to date and describes all new and changed functionality.

@mbissett
Copy link
Contributor

Understood, thanks for clarifying. :)

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

No branches or pull requests

2 participants