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

Draft: Docusaurus #216

Closed
wants to merge 10 commits into from
Closed

Draft: Docusaurus #216

wants to merge 10 commits into from

Conversation

iM-GeeKy
Copy link
Collaborator

@iM-GeeKy iM-GeeKy commented Dec 17, 2022

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

  • Adds an official documentation site to this repository using Docusaurus. This includes, but is not limited to.
  1. Installation
  2. Contributing
  3. Component usage, prop definitions, and interactive Expo snacks.
  • 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 into docusaurus and run npm 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

@RichardLindhout
Copy link
Member

Amazing!

@RichardLindhout
Copy link
Member

This is merged in master

@iM-GeeKy
Copy link
Collaborator Author

iM-GeeKy commented Dec 24, 2022

@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.

Screenshot 2022-12-24 at 7 48 00 AM

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

Screenshot 2022-12-24 at 7 54 02 AM

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.

@iM-GeeKy iM-GeeKy deleted the docusaurus branch December 26, 2022 13:05
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.

2 participants