Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
In order to make the documentation more accessible and easier to use, it makes a lot of sense to move the contents of the
README
into a dedicated documentation site. It looks like the Paper team is in the process of doing so and Docusaurus appears to be the standard. This will allow developers to more easily browse the documentation and interact with the library in order to generate more potential downloads, contributions, etc. The site is also robust enough to accommodate future components, pages, etc.Features
Moved most of the
README.md
contents to the Docusaurus site.Removed the
/examples
directory. The new examples are all moved to separate Expo snacks. This provides an easier way to spin up and interactive with each component to help developers better decide if this library is for them.Moved the
Contributing.md
to a dedicate page on the Docusaurus site.Added new
.github/ISSUE_TEMPLATE
files to standardize bugs, features, and questions flowing into the repository.@RichardLindhout Can you please check out this branch. You should be able to
cd
intodocusaurus
and runnpm start
to bring it up locally. It also doesn't look like I can deploy this thing b/c of permissions, so I was wondering if you could finish this last piece out in order to make it available. It looks like we can and should create a github action to auto-deploy this. https://docusaurus.io/docs/deployment#deploying-to-github-pages