web-ridge / react-native-paper-dates

Smooth and fast cross platform Material Design date and time picker for React Native Paper
https://www.reactnativepaperdates.com
MIT License
642 stars 166 forks source link

Draft: Docusaurus #216

Closed iM-GeeKy closed 1 year ago

iM-GeeKy commented 1 year ago

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

  1. Installation
  2. Contributing
  3. Component usage, prop definitions, and interactive Expo snacks.
RichardLindhout commented 1 year ago

Amazing!

RichardLindhout commented 1 year ago

This is merged in master

iM-GeeKy commented 1 year ago

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