From 0d4155e07ea740fa542ea23c4ecf75200d63153e Mon Sep 17 00:00:00 2001 From: Lars Reimann Date: Fri, 12 Apr 2024 19:27:31 +0200 Subject: [PATCH 1/3] docs: hide navigation on home page --- docs/README.md | 20 ++++++++------------ 1 file changed, 8 insertions(+), 12 deletions(-) diff --git a/docs/README.md b/docs/README.md index f06117bcc..634c917e0 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,14 +1,14 @@ -# Safe-DS DSL +--- +hide: + - navigation +--- -[![Visual Studio Marketplace Version](https://img.shields.io/visual-studio-marketplace/v/safe-ds.safe-ds)](https://marketplace.visualstudio.com/items?itemName=safe-ds.safe-ds) -[![Main](https://github.com/Safe-DS/DSL/actions/workflows/main.yml/badge.svg)](https://github.com/Safe-DS/DSL/actions/workflows/main.yml) -[![codecov](https://codecov.io/gh/Safe-DS/DSL/branch/main/graph/badge.svg?token=ma0ytglhO1)](https://codecov.io/gh/Safe-DS/DSL) -[![Documentation Status](https://readthedocs.org/projects/safe-ds-dsl/badge/?version=stable)](https://dsl.safeds.com) +# Safe-DS DSL Safely develop Data Science programs with a statically checked domain specific language (DSL) and integrated tools for data inspection. -![demo](img/readme/demo.gif) +![demo](img/readme/demo.gif){ max-width="400" } ## Installation @@ -20,12 +20,8 @@ inspection. 1. Install [Python](https://www.python.org/) (3.11 or 3.12). 2. Run `pip install "safe-ds-runner>=0.10.0,<0.11.0"` in a command line to download the latest matching Runner version from [PyPI](https://pypi.org/project/safe-ds-runner/). - 3. If the Visual Studio Code extension cannot start the runner, adjust the setting `safe-ds.runner.command`. - Enter the absolute path to the Runner executable. - -## Documentation - -You can find the full documentation [here](https://dsl.safeds.com). + 3. If the Visual Studio Code extension cannot start the runner, adjust the setting `safe-ds.runner.command`. + Enter the absolute path to the Runner executable. ## Contributing From d9c1b0792935bad0f0700ab5545bd02b557aaf23 Mon Sep 17 00:00:00 2001 From: Lars Reimann Date: Fri, 12 Apr 2024 19:27:48 +0200 Subject: [PATCH 2/3] docs: separate README for github --- .github/README.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 .github/README.md diff --git a/.github/README.md b/.github/README.md new file mode 100644 index 000000000..7bafa20f2 --- /dev/null +++ b/.github/README.md @@ -0,0 +1,38 @@ +# Safe-DS DSL + +[![Visual Studio Marketplace Version](https://img.shields.io/visual-studio-marketplace/v/safe-ds.safe-ds)](https://marketplace.visualstudio.com/items?itemName=safe-ds.safe-ds) +[![Main](https://github.com/Safe-DS/DSL/actions/workflows/main.yml/badge.svg)](https://github.com/Safe-DS/DSL/actions/workflows/main.yml) +[![codecov](https://codecov.io/gh/Safe-DS/DSL/branch/main/graph/badge.svg?token=ma0ytglhO1)](https://codecov.io/gh/Safe-DS/DSL) +[![Documentation Status](https://readthedocs.org/projects/safe-ds-dsl/badge/?version=stable)](https://dsl.safeds.com) + +Safely develop Data Science programs with a statically checked domain specific language (DSL) and integrated tools for data +inspection. + +![demo](../docs/img/readme/demo.gif) + +## Installation + +1. Get the latest extension for [Visual Studio Code](https://code.visualstudio.com/) from the + [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=safe-ds.safe-ds). This sets up a + complete _development environment_ for Safe-DS programs. +2. To _execute_ Safe-DS programs, the [Safe-DS Runner](https://github.com/Safe-DS/Runner) has to be installed and + configured additionally: + 1. Install [Python](https://www.python.org/) (3.11 or 3.12). + 2. Run `pip install "safe-ds-runner>=0.10.0,<0.11.0"` in a command line to download the latest matching Runner version + from [PyPI](https://pypi.org/project/safe-ds-runner/). + 3. If the Visual Studio Code extension cannot start the runner, adjust the setting `safe-ds.runner.command`. + Enter the absolute path to the Runner executable. + +## Documentation + +You can find the full documentation [here](https://dsl.safeds.com). + +## Contributing + +We welcome contributions from everyone. As a starting point, check the following resources: + +* [Contributing page](https://github.com/Safe-DS/DSL/contribute) + +If you need further help, please [use our discussion forum][forum]. + +[forum]: https://github.com/orgs/Safe-DS/discussions From f804c8d8f2e47cdbc744332bd50c8be7f672a545 Mon Sep 17 00:00:00 2001 From: Lars Reimann Date: Fri, 12 Apr 2024 19:39:21 +0200 Subject: [PATCH 3/3] docs: improve settings for navigation --- docs/mkdocs.yml | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 25450e1e6..690c37f0b 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -72,11 +72,15 @@ theme: features: - content.code.copy - content.tooltips - - navigation.tabs - navigation.indexes - navigation.instant + - navigation.instant.progress + - navigation.prune - navigation.sections + - navigation.tabs + - navigation.tabs.sticky - navigation.top + - toc.follow plugins: - literate-nav: