[Docs] Move Reference to a separate page for more space and better structure #2091 (#2092)

Author: peterschmidt85

docs/assets/stylesheets/extra.css

@@ -1276,37 +1276,25 @@ html .md-footer-meta.md-typeset a:is(:focus,:hover) {
         display: none;
     }
 
-    .md-tabs__item:nth-child(6) {
-        margin-left: auto;
-    }
-
     .md-tabs__item:nth-child(7) {
+        margin-left: auto;
         padding-right: 1.2rem;
     }
 
-    .md-tabs__item:nth-child(n+6):nth-child(-n+7) .md-tabs__link {
+    .md-tabs__item:nth-child(n+7) .md-tabs__link {
         visibility: hidden;
         width: 35px;
         display: inline-block;
         margin-top: 10px;
     }
 
-    .md-tabs__item:nth-child(n+6) .md-tabs__link:before {
+    .md-tabs__item:nth-child(n+7) .md-tabs__link:before {
         width: 38px;
         height: 38px;
         margin-top: 4px;
         visibility: visible;
     }
 
-    .md-tabs__item:nth-child(8) .md-tabs__link:after {
-        content: url('data:image/svg+xml,<svg fill="black" xmlns="http://www.w3.org/2000/svg" width="20px" height="20px" viewBox="0 0 16 16"><polygon points="5 4.31 5 5.69 9.33 5.69 2.51 12.51 3.49 13.49 10.31 6.67 10.31 11 11.69 11 11.69 4.31 5 4.31" data-v-e1bdab2c=""></polygon></svg>');
-        line-height: 14px;
-        margin-left: 4px;
-        position: relative;
-        top: 0;
-        margin-right: -7px;
-    }
-
     .twemoji.external {
         position: relative;
         top: 2.5px;
@@ -1323,7 +1311,7 @@ html .md-footer-meta.md-typeset a:is(:focus,:hover) {
         margin-right: -7px;
     }
 
-    .md-tabs__item:nth-child(6) .md-tabs__link:before {
+    .md-tabs__item:nth-child(7) .md-tabs__link:before {
         position: relative;
         content: '';
         width: 40px;
@@ -1337,20 +1325,6 @@ html .md-footer-meta.md-typeset a:is(:focus,:hover) {
         margin-top: 0;
     }
 
-    .md-tabs__item:nth-child(7) .md-tabs__link:before {
-        position: relative;
-        content: '';
-        width: 40px;
-        height: 35px;
-        display: inline-block;
-        -webkit-mask: url('data:image/svg+xml,<?xml version="1.0" encoding="utf-8"?><svg xmlns="http://www.w3.org/2000/svg" width="36" height="36" viewBox="-30 -30 606 572"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"></path></svg>') no-repeat 50% 50%;
-        mask: url('data:image/svg+xml,<?xml version="1.0" encoding="utf-8"?><svg xmlns="http://www.w3.org/2000/svg" width="36" height="36" viewBox="-30 -30 606 572"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"></path></svg>') no-repeat 50% 50%;
-        -webkit-mask-size: cover;
-        mask-size: cover;
-        background: -webkit-linear-gradient(45deg, black, black);
-        margin-top: 0;
-    }
-
     .md-tabs__link {
         display: flex;
         align-items: center;

docs/docs/reference/server/config.yml.md

@@ -4,15 +4,15 @@ The `~/.dstack/server/config.yml` file is used
 to [configure](../../installation/index.md#1-configure-backends) the `dstack` server cloud accounts
 and other sever-level settings such as encryption.
 
-## Backends
+## Configure backends { #backends }
 
 > The `dstack` server allows you to configure backends for multiple projects.
 > If you don't need multiple projects, use only the `main` project.
 
 Each cloud account must be configured under the `backends` property of the respective project.
 See the examples below.
 
-### Cloud providers
+### Cloud providers  { #clouds }
 
 #### AWS
 
@@ -739,11 +739,11 @@ projects:
 
 </div>
 
-### On-prem servers
+### On-prem servers  { #on-prem }
 
 #### SSH fleets
 
-For using `dstack` with on-prem servers, no backend configuration is required.
+> For using `dstack` with on-prem servers, no backend configuration is required.
 See [SSH fleets](../../concepts/fleets.md#ssh-fleets) for more details.
 
 #### Kubernetes
@@ -836,7 +836,7 @@ In case of a self-managed cluster, also specify the IP address of any node in th
 
     [//]: # (TODO: Provide short yet clear instructions. Elaborate on whether it works with Kind.)
 
-## Encryption
+## Enable encryption { #encryption }
 
 By default, `dstack` stores data in plaintext. To enforce encryption, you 
 specify one or more encryption keys.

docs/overrides/header-2.html

@@ -61,8 +61,8 @@
     {% endif %}-->
 
     <div class="md-header__buttons">
-      <a href="https://github.com/dstackai/dstack" target="_blank" class="md-button md-button--primary github">Star us</a>
-      <a href="https://discord.gg/u8SmfwPpMd" target="_blank" class="md-button md-button-secondary discord">Discord</a>
+      <a href="https://github.com/dstackai/dstack" target="_blank" class="md-button md-button--primary github">GitHub</a>
+      <!--<a href="https://discord.gg/u8SmfwPpMd" target="_blank" class="md-button md-button-secondary discord">Discord</a>-->
     </div>
   </nav>
   {% if "navigation.tabs.sticky" in features %}

docs/overrides/header.html

@@ -58,7 +58,7 @@
     <div class="md-header__buttons">
       <a href="https://sky.dstack.ai" target="_blank" class="md-button md-button-secondary external borderless">dstack Sky</a>
       <a href="https://github.com/dstackai/dstack" target="_blank" class="md-button md-button--primary github">Star us</a>
-      <a href="https://discord.gg/u8SmfwPpMd" target="_blank" class="md-button md-button-secondary discord">Discord</a>
+      <!--<a href="https://discord.gg/u8SmfwPpMd" target="_blank" class="md-button md-button-secondary discord">Discord</a>-->
     </div>
   </nav>
   {% if "navigation.tabs.sticky" in features %}

docs/overrides/main.html

@@ -108,7 +108,7 @@
                 <div class="tx-footer__section">
                     <div class="tx-footer__section-title">Resources</div>
                     <a href="/docs" class="tx-footer__section-link">Documentation</a>
-                    <a href="https://github.com/dstackai/dstack/releases" target="_blank" class="tx-footer__section-link external">What's new</a>
+                    <a href="https://github.com/dstackai/dstack/releases" target="_blank" class="tx-footer__section-link external">Changelog</a>
                     <a href="/blog" class="tx-footer__section-link">Blog</a>
                 </div>
 

mkdocs.yml

@@ -217,22 +217,23 @@ nav:
           - Projects: docs/concepts/projects.md
       - Guides:
           - Protips: docs/guides/protips.md
-          - Troubleshooting: docs/guides/troubleshooting.md
           - Server deployment: docs/guides/server-deployment.md
-      - Reference:
+          - Troubleshooting: docs/guides/troubleshooting.md
+  - Reference:
+      - .dstack.yml:
+          - dev-environment: docs/reference/dstack.yml/dev-environment.md
+          - task: docs/reference/dstack.yml/task.md
+          - service: docs/reference/dstack.yml/service.md
+          - fleet: docs/reference/dstack.yml/fleet.md
+          - gateway: docs/reference/dstack.yml/gateway.md
+          - volume: docs/reference/dstack.yml/volume.md
+      - Server:
           - server/config.yml: docs/reference/server/config.yml.md
-          - .dstack.yml:
-              - dev-environment: docs/reference/dstack.yml/dev-environment.md
-              - task: docs/reference/dstack.yml/task.md
-              - service: docs/reference/dstack.yml/service.md
-              - fleet: docs/reference/dstack.yml/fleet.md
-              - gateway: docs/reference/dstack.yml/gateway.md
-              - volume: docs/reference/dstack.yml/volume.md
-#          - profiles.yml: docs/reference/profiles.yml.md
-          - CLI: docs/reference/cli/index.md
-          - API:
-              - Python API: docs/reference/api/python/index.md
-              - REST API: docs/reference/api/rest/index.md
+      - CLI:
+          - dstack: docs/reference/cli/index.md
+      - API:
+          - Python API: docs/reference/api/python/index.md
+          - REST API: docs/reference/api/rest/index.md
   - Examples:
     - examples.md
     - Deployment:
@@ -250,10 +251,10 @@ nav:
         - Llama 3.2: examples/llms/llama32/index.md
     - Misc:
         - Docker Compose: examples/misc/docker-compose/index.md
+  - Partners: partners.md
   - Blog:
       - blog/index.md
-  - Partners: partners.md
+  - Discord: https://discord.gg/u8SmfwPpMd" target="_blank
 #  - Changelog: https://github.com/dstackai/dstack/releases" target="_blank
-#  - Discord: https://discord.gg/u8SmfwPpMd" target="_blank
 #  - GitHub: https://github.com/dstackai/dstack" target="_blank
 #  - Sign in: https://sky.dstack.ai" target="_blank