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(xychart): add README, add docs/xychart page, add XYChart gallery tile #963

Merged
merged 14 commits into from
Dec 15, 2020

Conversation

williaster
Copy link
Collaborator

@williaster williaster commented Dec 9, 2020

📝 Documentation

This PR

  • fleshes out the README for @visx/xychart to cover most aspects of the API, including some example code snippets
    • note I've added <details /> sections so that the rest of the /docs/xychart page with example tile(s) + comprehensive API will be visible without needed to scroll a lot
  • adds a /docs/xychart page to the demo site, and the XYChartTile to the gallery 🎉

I plan to add a couple more examples but non-gallery codesandboxes will be easier to create when the package is published

image

image

@kristw @hshoff

@coveralls
Copy link

coveralls commented Dec 9, 2020

Pull Request Test Coverage Report for Build 421994739

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 61.258%

Totals Coverage Status
Change from base Build 413784565: 0.0%
Covered Lines: 1732
Relevant Lines: 2694

💛 - Coveralls

@williaster
Copy link
Collaborator Author

williaster commented Dec 14, 2020

hmm, may not be able to cleanly create the @visx/xychart/animated index, right now I think because we have main: lib/index.js for the package, and that index doesn't reference lib/animated/index.js we don't get the correct types, etc. (which is failing the build)

@williaster
Copy link
Collaborator Author

Going to merge this since it's been open for a while and is just docs w(hich are blocking 1.3.0 as it stands), happy to address any feedback in a following PR

@williaster williaster merged commit d6fe1f3 into master Dec 15, 2020
@williaster williaster deleted the chris--xychart-docs branch December 15, 2020 01:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants