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

docs: Improve documentation #964

Merged
merged 1 commit into from
Feb 9, 2021

Conversation

NicholasBoll
Copy link
Member

@NicholasBoll NicholasBoll commented Feb 9, 2021

Summary

Added MDX helpers to improve Storybook Docs documentation and align with the new Canvas site documentation.

  • Added ExampleCodeBlock that takes in an example file and will show it live and set the source code to be the whole file. This makes it so stories are fully copy/pasteable into product
  • Added PropsTable component that creates a table of arguments.
  • Updated Card docs with this style

Additional References

Notice the code block includes import statements.
image

@cypress
Copy link

cypress bot commented Feb 9, 2021



Test summary

560 0 1 0


Run details

Project canvas-kit
Status Passed
Commit 3deebbe ℹ️
Started Feb 9, 2021 8:57 PM
Ended Feb 9, 2021 9:03 PM
Duration 05:41 💡
OS Linux Ubuntu Linux - 18.04
Browser Electron 80

View run in Cypress Dashboard ➡️


This comment has been generated by cypress-bot as a result of this project's GitHub integration settings. You can manage this integration in this project's settings in the Cypress Dashboard

@anicholls anicholls merged commit 8dcc951 into Workday:master Feb 9, 2021
@NicholasBoll NicholasBoll deleted the docs/improve-docs branch February 9, 2021 21:48
alanbsmith added a commit to alanbsmith/canvas-kit that referenced this pull request Feb 16, 2021
75e909f (upstream/master, master) feat(common): Add useIsRTL hook to common module (Workday#971)
771a215 fix(tabs): Remove event.preventDefault from TabList (Workday#969)
b7f87a1 Update Pagination component (Workday#954)
91acada Roll back to `pull_request`
69cc4b4 fix: Add crossorigin to font preloads (Workday#967)
ea5dbd8 ci: Use pull_request_target in GH Actions
159da10 docs: Fix Story names and extra imports (Workday#966)
8dcc951 docs: Improve documentation (Workday#964)
221fa1c feat: Add closeButtonAriaLabel to Modal Component (Workday#959)
339be74 ci: Remove jest code-coverage threshold (Workday#957)
6491da3 docs: Add compound component doc (Workday#937)
d7ec090 feat: Add window config option to inherit or override mono font family (Workday#916)
968130a chore: Bump ini from 1.3.5 to 1.3.7 (Workday#931)
27504a1 feat(skeleton): Add option for different skeleton colors (Workday#939)
3ba2da8 chore: Update @workday/canvas-system-icons-web dependency (Workday#940)
37cfd15 Add custom limit to CountBadge (Workday#935)
3634149 chore(form-field): Update FormField Readme (Workday#930)
42b9235 fix: Fix create component scripts (Workday#929)
b3ee342 docs: Standardize README badges for Labs components (Workday#928)
@alanbsmith alanbsmith mentioned this pull request Feb 16, 2021
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