Skip to content

Conversation

@DominicGBauer
Copy link
Contributor

Description

Create a pipeline that automates doc creation using MD files which can be displayed using Docusaurus. Using Docusaurus allows us access to a vast amount of functionality and an ever-improving ecosystem and is maintained by Meta.

Work Done

  • Used typedoc to autogenerate docs usable by Docusaurus
  • All Docusaurus output can be found in a new docs subdirectory from the root (not there was an issue with how yarn workspaces managed packages and it created conflicts with the autogeneration of the docs hence I left docs out of the yarn workspaces)

How to test

  • Run yarn build:packages
  • Run cd docs && yarn build && yarn start
  • Run cd docs && yarn build
  • In docs folder open index.html
  • Review

Screenshots

image

custom_edit_url: null
---

# PowerSync React Native SDK
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we look into generating this just-in-time as part of the deploy pipeline?

@Manrich121 Manrich121 requested review from Manrich121 and benitav and removed request for benitav and rkistner December 4, 2023 09:21
@DominicGBauer DominicGBauer removed the request for review from benitav December 4, 2023 11:55
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.

6 participants