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

chore: adds API docs for fast-colors and fast-animation #3359

Merged

Conversation

nicholasrice
Copy link
Contributor

@nicholasrice nicholasrice commented Jun 23, 2020

Description

This change wires up API docs for @microsoft/fast-animation and @microsoft/fast-colors. It also integrates those API docs into sites/website in the API docs sidebar section.

Motivation & context

Issue type checklist

  • Chore: A change that does not impact distributed packages.
  • Bug fix: A change that fixes an issue, link to the issue above.
  • New feature: A change that adds functionality.

Is this a breaking change?

  • This change causes current functionality to break.

Adding or modifying component(s) in @microsoft/fast-components checklist

Process & policy checklist

  • I have added tests for my changes.
  • I have tested my changes.
  • I have updated the project documentation to reflect my changes.
  • I have read the CONTRIBUTING documentation and followed the standards for this project.

@EisenbergEffect EisenbergEffect mentioned this pull request Jun 24, 2020
35 tasks
Copy link
Contributor

@EisenbergEffect EisenbergEffect left a comment

Choose a reason for hiding this comment

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

I admit to rubber stamping this a bit since it was so large of a docs PR. I scanned everything but pretty quickly.

sites/website/sidebars.js Show resolved Hide resolved
@@ -254,8 +257,10 @@ async function copyArticleMarkdown() {
// Copy the api.json files from the web-components packages.
async function copyAPI() {
for (const package of packages) {
const packageDir = glob.sync(path.resolve(`../../packages/**/${package}`))[0];
Copy link
Contributor

Choose a reason for hiding this comment

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

Nice.

@nicholasrice nicholasrice merged commit d7324e5 into master Jun 25, 2020
@nicholasrice nicholasrice deleted the users/nirice/add-api-extractor-to-colors-and-animation branch June 25, 2020 02:13
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.

3 participants