docs: make some correction to the doc

stateful · Sep 18, 2024 · ba5ed0c · ba5ed0c
1 parent 0fb9f1e
commit ba5ed0c
Show file tree

Hide file tree

Showing 9 changed files with 13 additions and 56 deletions.
diff --git a/docs/configuration/lifecycle-identity.md b/docs/configuration/lifecycle-identity.md
@@ -1,8 +1,3 @@
----
-sidebar_position: 6
-title: Lifecycle Identity
----
-
 # Lifecycle Identity
 
 The Lifecycle Identity feature in Runme is a tool that assigns unique identifiers and versions to individual cells, the entire file, or both, depending on your [configuration](https://docs.runme.dev/configuration/).
@@ -49,17 +44,3 @@ As shown in the image above, there are three levels of tracking available:
 - [Cell level](https://docs.runme.dev/configuration/cell-level): This tracks changes within individual cells in a document.
 - [Document level](https://docs.runme.dev/configuration/document-level): This monitors the entire document for any modifications or version changes.
 - All: This tracks changes made to both [Cell level](https://docs.runme.dev/configuration/cell-level) and [document](https://docs.runme.dev/configuration/document-level) levels.
-
-## Cell Run Grouping
-
-Cell Run Grouping is an important tool in Runme that works together with the Lifecycle Identity feature. It improves the organization and tracking of code runs, especially when working with Markdown files or individual cells within these files. This functionality works when outputs are saved to the [Runme Cloud](https://app.runme.dev/), as it allows for a more structured and insightful analysis of the code's performance over time.
-
-### How Cell Run Grouping Works
-
-When a user saves the output of a cell or an entire Markdown file to the Runme Cloud, Runme assigns a unique identity to that file or cell. This identity is important for the cell run grouping process, as it ensures that any subsequent iterations or runs of that file or cell are recorded and grouped under the same identity in the cloud.
-
-**Here is a breakdown**: Whenever a code is run, the output is stored in the same group as the previous, with the exact time of each run clearly stated. This chronological arrangement of each code provides a comprehensive view of the code's changes and performance over time.
-
-![cell-grouping](/img/cell-run-grouping.png)
-
-Cell grouping is not just a simple collection of executed commands in a cell or document but it is an organized, time-stamped record of each run.
diff --git a/docs/getting-started/cli.md b/docs/getting-started/cli.md
@@ -1,8 +1,3 @@
----
-sidebar_position: 2
-title: CLI
----
-
 # Runme CLI
 
 With the CLI, you can run commands from your Notebooks in the terminal. The Runme CLI is available for MacOS, Windows, and other platforms.
@@ -212,6 +207,6 @@ This command opens Runme in your web browser.
 
 See more resources on how Runme works:
 
-[Getting started with the browser](/getting-started/web)
-[Getting started in VS Code](/getting-started/vscode)
-[Getting started on VS Code SSH and Remote](/getting-started/vscode-ssh)
+- [Getting started with the browser](/getting-started/web)
+- [Getting started in VS Code](/getting-started/vscode)
+- [Getting started on VS Code SSH and Remote](/getting-started/vscode-ssh)
diff --git a/docs/guide/bigquery.md b/docs/guide/bigquery.md
@@ -1,9 +1,6 @@
----
----
-
 # BigQuery
 
-In this guide, you will learn how to manage data queries using BigQueris and Runme.
+In this guide, you will learn how to manage data queries using BigQuery and Runme.
 
 ## Prerequisites
 

diff --git a/docs/guide/cloud-render/cloud-run.md b/docs/guide/cloud-render/cloud-run.md
@@ -1,7 +1,3 @@
----
-title: Google Cloud Run
----
-
 # Google Cloud Run
 
 Runme Cloud Renderers enable you to access various cloud resources directly within your Markdown files without the need to log into your cloud console. With Cloud Renderers, you can manage your Google Cloud Run resources and perform various operations without leaving your Markdown environment.
@@ -91,10 +87,6 @@ export PROJECT_ID="runme-ci"
 echo "PROJECT_ID set to $PROJECT_ID"
 ```
 
-This is how the prompt looks like.
-
-![prompt](/img/integration/runme-set-var.png)
-
 **Specify the Project for Visualization**
 
 After setting your project ID, you can visualize your project. To do this, paste a link from your console that specifies the desired project for visualization, like the link below, and click run.

diff --git a/docs/guide/docker.md b/docs/guide/docker.md
@@ -1,7 +1,3 @@
----
-sidebar_position: 3
----
-
 # Docker
 
 In this guide, we will walk you through the use cases of integrating Runme and Docker.
@@ -125,8 +121,6 @@ docker run -p 80:5000 nginx
 
 If a cell block takes a lot of time to execute, you can also run such a cell in the background using [Runme’s background mode](/configuration/cell-level#background-task). This will enable you to save time and move on to other tasks while your previous task is still running.
 
-![background mode](/img/runme-background.png)
-
 ### Sleep a Container
 
 You can instruct Docker to make a container sleep.

diff --git a/docs/guide/k8s/k8s-secret.md b/docs/guide/k8s/k8s-secret.md
@@ -1,3 +1,9 @@
+---
+runme:
+  id: 01J82VN641J9K3A3G98ASV75SR
+  version: v3
+---
+
 # Sealed Secrets
 
 Runme provides a platform for documenting processes and instructions. It integrates swiftly with cloud infrastructures, including Kubernetes and its resources.
@@ -113,7 +119,7 @@ Make sure to replace placeholders like **`mysecret.yaml`** and **`mysealedsec
 
 In this guide, we explored how to encrypt, decrypt, delete, deploy a Kubernetes secrtes using sealed secrets and Runme. Runme made the process of carrying all these operations out swiftly by utilizing its features.
 
-Some [key features](/usage/hello-world) of Runme that make it stand out include:
+Some [key features](/usage) of Runme that make it stand out include:
 
 - Its ability to simplify the copying and pasting of commands and codes,
 - Run tasks in the background, interact with your terminal,

diff --git a/docs/resources/limitations.md b/docs/resources/limitations.md
@@ -1,10 +1,6 @@
----
-title: Limitations
----
-
 # Known Limitations
 
-- Runme currently only has rudimentary support for PowerShell. While PowerShell is not limited to Windows, it is its primary platform. We recommend using [WSL](https://code.visualstudio.com/docs/remote/wsl).
+- Runme currently only has rudimentary support for PowerShell. While PowerShell is not limited to Windows, it is its primary platform. We recommend using [WSL](../installation/windows).
 - Please [report any issues](https://github.com/stateful/runme/issues/new) you encounter, big or small, to help us make Runme better.
 
 ## Communication & Support

diff --git a/docs/usage/auto-save.md b/docs/usage/auto-save.md
@@ -1,8 +1,4 @@
----
-title: Auto-Save session outputs
----
-
-# Auto-Save Auto-Save session outputs
+# Auto-Save session outputs
 
 The Runme auto-save feature efficiently saves and manages your commands and executed cells for future reference. When you run a command within your Runme Notebook, a Session Ouputs file is automatically generated. This captures a complete copy of the original Markdown document, along with the generated outputs, details on when each cell was run, the time it took to run the cell, and exit codes. You can also turn your command/generated outputs into a [Runme gist](/usage/runme-gist).
 

diff --git a/static/img/cell-run-grouping.png b/static/img/cell-run-grouping.png