Skip to content

Commit

Permalink
Merge pull request #116 from skytable/octave
Browse files Browse the repository at this point in the history
Add docs for octave
  • Loading branch information
ohsayan authored Dec 5, 2023
2 parents a4bbb10 + cdd5e73 commit f3ca270
Show file tree
Hide file tree
Showing 93 changed files with 5,318 additions and 7,504 deletions.
5 changes: 1 addition & 4 deletions .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,7 @@ jobs:
if: steps.cache.outputs.cache-hit != 'true'
run: yarn install
- name: Build docs
run: |
chmod +x doc.sh
./doc.sh
yarn build
run: yarn build
- name: Deploy docs
env:
BOT_USER: ${{ secrets.BOT_INIT_USER }}
Expand Down
6 changes: 1 addition & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,8 @@
# Skytable Documentation
Source for the documentation site for Skytable. You can [read the docs here](https://skytable.github.io/docs).
Source for the documentation site for Skytable. You can [read the docs here](https://docs.skytable.io).

## Contributing
Fork, make changes and submit a PR!

### Making changes to the `docs/Actions` folder
The `Actions` folder contains the documentation for the actions that Skytable supports. However, by no means should you modify them _here_.
You should instead update [this file](https://github.com/skytable/skytable/blob/next/actiondoc.yml). The documentation for the actions or the _actiondoc_ as we call it is built automatically from this file by using the `docbuilder` (our custom tool for generating documentation).

## License
The documentation is licensed under the [CC-BY-SA-4.0](./LICENSE-CC) license while the `docbuilder` is licensed under the [GPL-3.0](./LICENSE-GPL3) license.
3 changes: 0 additions & 3 deletions doc.sh

This file was deleted.

148 changes: 0 additions & 148 deletions docbuilder/Cargo.lock

This file was deleted.

14 changes: 0 additions & 14 deletions docbuilder/Cargo.toml

This file was deleted.

199 changes: 0 additions & 199 deletions docbuilder/src/doc.rs

This file was deleted.

Loading

0 comments on commit f3ca270

Please sign in to comment.