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

Update package documentation #64

Merged
merged 6 commits into from
Mar 26, 2020
Merged

Update package documentation #64

merged 6 commits into from
Mar 26, 2020

Conversation

tterb
Copy link
Contributor

@tterb tterb commented Mar 26, 2020

Description

  • Updated the README.md to provide more context and usage information about the included components
  • Removed the "Troubleshooting" section in favor of a FAQ page to more effectively address a number of recurring questions/issues.
  • Updated the CONTRIBUTING.md to include a link to the FAQ page and ESlint config.
  • Added FAQ and Knowledge Base links to the question_template.md

Motivation and Context

How Has This Been Tested?

N/A

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
    • I have updated the documentation accordingly.
  • All new and existing tests passed.

This change is Reviewable

@tterb tterb changed the title Update README.md and CONTRIBUTING.md Update package documentation Mar 26, 2020
@tterb tterb merged commit fc13d20 into master Mar 26, 2020
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.

misleading demo code at homepage
1 participant