Introduction

Welcome to documentation for Sparrow App. This website is created for following objectives:

1. To provide location for draft documentation which is still under review or not finalized and cannot be hosted on public site.
2. To provide a place to host flows which are still work in progress.
3. To provide a place to host enterprise level functionalities documentation and guides which are not part of the open source version.

Contributing

The documentation is created using Docusaurus. Docusaurus is an open source project by Meta which facilitates hosting version controlled documentation. It uses markdown files for documentation to ensure standardized docs which are easy to create and edit.

To contribute, please clone the project from repository, create a branch and start adding markdown pages inside docs folder. Please refer to getting started guide of Docusaurus for detailed tutorial and guide on how to get started.

What you'll need

• Node.js version 18.0 or above:
  • When installing Node.js, you are recommended to check all checkboxes related to dependencies.

Start your site

Run the development server:

cd sparrow-docs
npm run start

The cd command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there.

The npm run start command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/.

How to contribute?

Please check the Contributing Tutorial for the same.