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

[Documentation] Peregrine hooks reference v3.0.0 #1278

Merged

Conversation

Projects
None yet
3 participants
@jcalcaben
Copy link
Contributor

commented May 28, 2019

Description

  • Add JSDoc annotations to the Peregrine hooks.
  • Add ability to create markdown content from JSDoc annotations
  • Create reference docs from JSDoc annotations

Related Issue

Closes #1237

Verification Steps

  1. Make sure you have ruby and bundler installed
  2. Navigate to the pwa-devdocs project directory
  3. Run npm run build-reference-doc-snippets
  4. Verify that the following files exist in src/_includes/_auto-generated/peregrine/src/hooks:
    • useApolloContext.md
    • useDropdown.md
    • useEventListener.md
    • useQuery.md
    • useQueryResult.md
  5. Run npm run develop
  6. Verify that the site builds successfully.
  7. Navigate to the Peregrine section (/peregrine/)
  8. Verify the existence of the Custom React Hooks section in the left hand table of contents
  9. Verify each of the generated hooks have corresponding pages in that section and contain reference data from the source code.

How Have YOU Tested this?

See Verification Steps

Checklist:

  • I have updated the documentation accordingly, if necessary.
  • I have added tests to cover my changes, if necessary.
@now

This comment has been minimized.

Copy link

commented May 28, 2019

This pull request is automatically deployed with Now.
To access deployments, click Details below or on the icon next to each push.

Latest deployment for this branch: https://venia-git-jimothy-gh-1237peregrine-hooks-reference-v300.magento-research1.now.sh

@jcalcaben jcalcaben referenced this pull request May 28, 2019

Closed

[Documentation] Peregrine hooks reference #1253

1 of 2 tasks complete

@jcalcaben jcalcaben marked this pull request as ready for review May 28, 2019

@dpatil-magento dpatil-magento requested a review from supernova-at May 28, 2019

@dpatil-magento dpatil-magento merged commit c24c285 into release/3.0 May 28, 2019

7 checks passed

AWS CodeBuild us-east-1 (pwa-pull-request-build) Build succeeded for project pwa-pull-request-build
Details
AWS CodeBuild us-east-1 (pwa-pull-request-test) Build succeeded for project pwa-pull-request-test
Details
bundlesize Total bundle size is 107.83KB/213KB (-null)
Details
licence/cla Contributor License Agreement is signed.
Details
now Deployment has completed
Details
now/packages/venia-concept/package.json is ready
now/packages/venia-concept/server-lambda.js is ready
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.