Closed iM-GeeKy closed 1 year ago
Amazing!
This is merged in master
@RichardLindhout
If the pages site is deployed we should update this in the README
as now we aren't providing a link to any documentation.
It looks like the action is pointing to https://web-ridge.github.io/react-native-paper-dates/ but it is saying it doesn't load properly.
The error is showing
which it sounds like it wants us to update the baseUrl
value found in the docusaurus.config.js
. Note this is my first time actually using docusaurus, so there is a bit of a learning curve for me.
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
[x] Moved most of the
README.md
contents to the Docusaurus site.[x] 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.[x] Moved the
Contributing.md
to a dedicate page on the Docusaurus site.[x] 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