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

Fix/fold wp cli into hookdocs site #312

Merged

Conversation

ActuallyConnor
Copy link
Contributor

@ActuallyConnor ActuallyConnor commented Oct 6, 2021

Description of the Change

  • Port our WP-CLI commands docs into the hookdoc site
  • Rename it to ClassifAI Developer Documentation (like what ElasticPress does).
  • Add a simple reference in the README.md

#281

Checklist:

  • I have read the CONTRIBUTING document.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my change.
  • All new and existing tests passed.

Applicable Issues

#281

Changelog Entry

Port WP-CLI commands docs into the hookdoc site. Rename the site to ClassifAI Developer Documentation. Add a simple reference to the hookdoc site in the README.md.

@ActuallyConnor ActuallyConnor marked this pull request as ready for review October 6, 2021 15:02
@jeffpaul jeffpaul added this to the 1.8.0 milestone Oct 6, 2021
@jeffpaul jeffpaul requested review from a team and faisal-alvi and removed request for a team October 6, 2021 17:01
README.md Outdated
Comment on lines 129 to 130
### ClassifAI Settings Commands

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please also remove the "ClassifAI Settings Commands" section as it is also covered in the docs. The next title after the "Check out.." line should be "Frequently Asked Questions".

README.md Outdated
Comment on lines 20 to 21
- Check out the [ClassifAI docs](https://10up.github.io/ClassifAI/).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line is not required. It's already added below. Please remove from here.

README.md Outdated
@@ -17,6 +17,8 @@
* [Changelog](#changelog)
* [Contributing](#contributing)

- Check out the [ClassifAI docs](https://10up.github.io/ClassifAI/).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The link path is case-sensitive. Please change ClassifAI to classifai

README.md Outdated
Skip first N images.

default: `false`.
- Check out the [ClassifAI docs](https://10up.github.io/ClassifAI/).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The link path is case-sensitive. Please change ClassifAI to classifai

@ActuallyConnor
Copy link
Contributor Author

@faisal-alvi all the requested changes should be made now 😃

@jeffpaul jeffpaul merged commit 9d971c2 into 10up:develop Oct 8, 2021
@ActuallyConnor
Copy link
Contributor Author

@faisal-alvi @jeffpaul any possibility we could add the Hacktoberfest tag to the issue?

@jeffpaul
Copy link
Member

jeffpaul commented Oct 8, 2021

@ActuallyConnor sure, let me do that, though not sure if Digital Ocean will count it after the fact but worth a shot!

@ActuallyConnor
Copy link
Contributor Author

It worked 👍

@jeffpaul jeffpaul linked an issue Oct 13, 2021 that may be closed by this pull request
@jeffpaul jeffpaul modified the milestones: 1.8.0, 1.7.1 Apr 22, 2022
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.

Fold WP-CLI docs into hookdocs site
3 participants