https://github.com/shafthq/shafthq.github.io

SHAFT_Engine's official user guide, powered by Docusaurus 3.x
https://github.com/shafthq/shafthq.github.io

automated-testing automation documentation shaft-engine test-automation testing-tools

Last synced: about 2 hours ago
JSON representation

SHAFT_Engine's official user guide, powered by Docusaurus 3.x

• Host: GitHub
• URL: https://github.com/shafthq/shafthq.github.io
• Owner: ShaftHQ
• License: mit
• Created: 2020-08-12T14:11:10.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-09-11T08:56:58.000Z (2 months ago)
• Last Synced: 2024-09-11T23:19:17.719Z (2 months ago)
• Topics: automated-testing, automation, documentation, shaft-engine, test-automation, testing-tools
• Language: JavaScript
• Homepage: https://shafthq.github.io/
• Size: 24.5 MB
• Stars: 9
• Watchers: 2
• Forks: 11
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# SHAFT User Guide

This website is built using [Docusaurus 3](https://docusaurus.io/), a modern static website generator.

### Installation

```shell

yarn install

```

### Local Development

- Start a local server by running this command:

```shell

yarn start

```

- A new browser window will open; most changes are reflected live without having to restart the server.

- Create your own .md files under the `docs` or `blog` directories.

- You can use something like https://dillinger.io/ to help you create the .md file.

- Add your new file to the sidebar if needed by editing this file `/sidebars.js`.

### Deployment

- Just open a PR with your changes, a temp deployment will be created so that you can view your changes live.

- Once you're happy with the output, submit your PR for review.

- Once it is merged, the changes will be automatically deployed to https://shafthq.github.io/

### Support

If you need support to contribute, kindly join our slack channel to align and discuss.