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/hookdoc generation #191

Merged
merged 8 commits into from
Mar 5, 2020
Merged

Fix/hookdoc generation #191

merged 8 commits into from
Mar 5, 2020

Conversation

helen
Copy link
Contributor

@helen helen commented Mar 5, 2020

Description of the Change

Add/flesh out hook docs so they can be picked up by the page generator. IMPORTANT NOTE: This PR also changes the action to run on develop instead of just master; once this is confirmed to be working we should switch it back to master so hook docs don't update separately from releases.

Alternate Designs

n/a

Benefits

Actual hook docs at https://10up.github.io/classifai/

Possible Drawbacks

n/a

Verification Process

Ran npm run build:docs locally and checked every single hook doc page.

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

See #189

Changelog Entry

n/a

@helen helen requested a review from jeffpaul March 5, 2020 03:49
Copy link
Member

@jeffpaul jeffpaul left a comment

Choose a reason for hiding this comment

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

looks good to me, thanks!

@jeffpaul jeffpaul added this to the 1.6.0 milestone Mar 5, 2020
@helen helen merged commit bdee8d4 into develop Mar 5, 2020
@helen helen deleted the fix/hookdoc-generation branch March 5, 2020 14:29
@jeffpaul jeffpaul modified the milestones: 1.6.0, 1.5.1 Mar 6, 2020
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.

2 participants