Documentation
Here is the process for improving this documentation.
Editing
- Fork the repository.
- Clone your fork.
- Open the project workspace (
vscode-sqltools.code-workspace
) with VS Code. - Create a branch from the
dev
branch. - Expand the
docs
root folder. - Edit pages. For example this page is at
src/pages/en/contributing/documentation.mdx
withindocs
Notes:
- If changing home.mdx try to keep README.md (in
vscode-sqltools
root folder of the workspace) in sync.
Previewing
- In the Debug view’s dropdown choose
Development server (docs)
and run it. - In the Terminal tab of the Panel, look for a terminal instance containing text like this:
Debugger attached.
astro v1.2.1 started in 818ms
┃ Local http://localhost:3000/
┃ Network use --host to expose
- Use Ctrl/Cmd+Click to open the link in a browser.
Submitting
- Stage your changes.
- Push your branch to your fork.
- Create a PR on the main repository requesting that your branch gets merged.