skysql-docs

Installation

To install the repository, follow these steps:

1. Clone the repository by running: git clone git@github.com:skysqlinc/skysql-docs.git

Local Debugging

Using VS Code Markdown Extension

One option for local debugging is to use the VS Code Markdown extension. Please note that this method allows you to preview only the current page.

Using MkDocs

Another option is to use MkDocs for local debugging. Follow these steps:

1. Install MkDocs by running: pip install mkdocs
2. Install the MkDocs Material theme by running: pip install mkdocs-material
3. Serve the documentation locally by running: mkdocs serve

Development Practices

When making changes:

1. Create a new branch for your changes: git checkout -b new-branch-name
2. Test your changes locally.
3. Commit your changes:
   • git add .
   • git commit -m "Your commit message"
4. Push your changes to the remote repository: git push origin new-branch-name
5. Create a pull request for your changes to be reviewed and merged into the main branch.

Sample Pull Request Recording

Download Video Tutorial