sekharvth / symbl-docs

Symbl.ai open sources its documentation into a GitHub repository for you as a developer to actively develop through pull requests.

Symbl Documentation

Welcome to the Symbl Documentation repository!

Our documentation site is built using Docusaurus 2, a static site generator.

Table of Contents

• Points to Note
• How to Contribute
• Setup Docs Locally
• Installation
• Local Development

Points to Note

• To submit Pull Requests (PRs), always use the develop as the base branch.
• We merge changes to master on a weekly basis.
• Go through our Code of Conduct for general best practices to foster community.
• We follow the writing guidelines of Microsoft Styleguide and Google Developer Documentation Style guide so ensure you refer to the same for any editorial guidance for writing and syntax.

How to Contribute

To contribute to our documentation,

1. Add in your suggestions (by clicking on "Edit this page" button on our docs),
2. Enter the required details about the PR. This will give us additional context and a sense what is required of our team.
3. Submit a Pull Request (PR).

The PR are reviewed every Thursdays by our team.

If you wish to suggest a new topic, want to request for additional details or raise any other issues, you can Open an Issue. The resolution time for Issues reported are the same as the PRs.

Setting up Docs locally

1. Clone the Symbl Docs Repo

• Using SSH:

$ git clone [e-mail]:symblai/symbl-docs.git

OR

• Using HTTPS:

$ git clone https://github.com/symblai/symbl-docs.git

2. Open your local directory where you cloned the docs

$ cd symbl-docs

3. Switch to develop branch to make changes

$ git checkout develop

Installation

$ yarn

Local Development

$ yarn start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Build

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

$ GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.