Skip to content
New issue

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

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

Already on GitHub? # to your account

[Documentation] Toasts reference docs #1574

Merged
merged 8 commits into from
Aug 23, 2019

Conversation

jcalcaben
Copy link
Contributor

@jcalcaben jcalcaben commented Aug 16, 2019

Description

Create documentation for the toasts hooks and venia component

Related Issue

Closes #1342

Verification Steps

  1. Navigate to the pwa-devdocs directory
  2. Build the HTML: npm run build
  3. Verify the following docs are autogenerated:
    • src/_includes/auto-generated/venia-ui/lib/components/ToastContainer/toastContainer.md
    • src/_includes/auto-generated/peregrine/lib/Toasts/useToasts.md
    • src/_includes/auto-generated/peregrine/lib/Toasts/useToastContext.md
  4. Verify the auto-generated docs have content based on the doc blocks in the source files.

Note: There is no need to preview server since this content will not be published until the component is published to NPM.

Screenshots / Screen Captures (if appropriate)

Checklist

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

@vercel
Copy link

vercel bot commented Aug 16, 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://pwa-studio-git-jimothy-gh-1342toasts-docs.mmansoor.now.sh

@PWAStudioBot
Copy link
Contributor

PWAStudioBot commented Aug 16, 2019

Messages
📖

Access a deployed version of this PR here. Make sure to wait for the "pwa-pull-request-deploy" job to complete.

📖 DangerCI Failures related to missing labels/description/linked issues/etc will persist until the next push or next nightly build run (assuming they are fixed).

Generated by 🚫 dangerJS against 8d5f9a8

@jcalcaben jcalcaben added version: Minor This changeset includes functionality added in a backwards compatible manner. pwa-4.0.0 To track PWA 4.0.0 tickets labels Aug 20, 2019
@jcalcaben jcalcaben marked this pull request as ready for review August 20, 2019 18:29
@jcalcaben jcalcaben changed the title [WIP] Toasts reference docs [Documentation] Toasts reference docs Aug 20, 2019
@dpatil-magento dpatil-magento merged commit ad9a4ce into develop Aug 23, 2019
@dpatil-magento dpatil-magento deleted the jimothy/gh-1342_toasts-docs branch August 23, 2019 15:22
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
pkg:peregrine pkg:venia-ui pwa-4.0.0 To track PWA 4.0.0 tickets version: Minor This changeset includes functionality added in a backwards compatible manner.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[doc]: Toasts documentation
4 participants