From 6208b5845875d345aa3d6bdda425f55428fb31f4 Mon Sep 17 00:00:00 2001 From: Konstantinos Kaloutas Date: Wed, 1 Nov 2023 12:07:52 +0200 Subject: [PATCH] pull contributing doc from main project --- .github/workflows/website.yml | 1 + docs/contribute/develop.md | 27 --------------------------- mkdocs.yml | 2 +- 3 files changed, 2 insertions(+), 28 deletions(-) delete mode 100644 docs/contribute/develop.md diff --git a/.github/workflows/website.yml b/.github/workflows/website.yml index ee21ef4..80ae66d 100644 --- a/.github/workflows/website.yml +++ b/.github/workflows/website.yml @@ -28,6 +28,7 @@ jobs: python-version: 3.x - run: curl https://raw.githubusercontent.com/re-path/studio/main/CHANGELOG.md > ./docs/roadmap/changelog.md + - run: curl https://raw.githubusercontent.com/re-path/studio/main/CONTRIBUTING.md > ./docs/roadmap/CONTRIBUTING.md - run: pip install pip install mkdocs-material=="9.4.5" - run: mkdocs gh-deploy --clean --force diff --git a/docs/contribute/develop.md b/docs/contribute/develop.md deleted file mode 100644 index a9aef1b..0000000 --- a/docs/contribute/develop.md +++ /dev/null @@ -1,27 +0,0 @@ -# Develop - -Thank you for your interest in actively participating in the project's development! -Please read the [Contributor Covenant Code of Conduct](https://github.com/re-path/studio/blob/main/CODE_OF_CONDUCT.md) and the [Contributor License Agreement](cla.md) first. - -## How to Run - -Install the dependencies. -``` -npm install -``` -Build and watch the project files . -``` -npm run dev -``` -Run electron on a different terminal. -``` -npm run electron -``` - -## Useful shortcuts - -``` -Ctrl+Shift+I Toggle devtools -Ctrl+H Toggle 10x -Ctrl+R Reload app -``` diff --git a/mkdocs.yml b/mkdocs.yml index 8ff1d2d..35c6fe9 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -42,7 +42,7 @@ nav: - Docs: - docs/shortcuts.md - Contribute: - - contribute/develop.md + - contribute/CONTRIBUTING.md - CLA: contribute/cla.md - Changelog: roadmap/changelog.md