Skip to content

Commit

Permalink
Renaming + fixing links
Browse files Browse the repository at this point in the history
  • Loading branch information
kordwarshuis committed Mar 4, 2025
1 parent b7ffbaa commit 192d168
Show file tree
Hide file tree
Showing 15 changed files with 44 additions and 26 deletions.
11 changes: 11 additions & 0 deletions docs/_content-backup/various-snippets.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Various snippets

## Video

<video controls poster={require('@site/static/video/spec-up-t-menu.jpg').default}>
<source src="https://dwarshuis.com/various/spec-up-t/documentation-website/video/spec-up-t-menu.mp4" type="video/mp4" />
Your browser does not support video tags
</video>

[Link to the video](https://dwarshuis.com/various/spec-up-t/documentation-website/video/spec-up-t-menu.mp4)

2 changes: 1 addition & 1 deletion docs/advanced-features/add.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ git init
cd ..
```

Now that you're outside the repo directory (!): Go over [Installation](../getting-started/installation/installation.md) and create a new repo with the established name. In the example `Main-KERI-glossary`, you start with:
Now that you're outside the repo directory (!): Go over [Installation](../getting-started/local-installation/installation.md) and create a new repo with the established name. In the example `Main-KERI-glossary`, you start with:

```
npx create-spec-up-t < established dirname >
Expand Down
2 changes: 1 addition & 1 deletion docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Unlike the DIF Spec-Up repository, the Spec-Up-T repository **does not generate

This functionality has been moved to the Spec-Up-T *installer*. Spec-Up-T is now an npm package that should be installed via `package.json`.

For more details, refer to [the installation section](./getting-started/installation/installation.md).
For more details, refer to [the installation section](./getting-started/local-installation/installation.md).

:::

Expand Down
8 changes: 0 additions & 8 deletions docs/getting-started/installation/_category_.json

This file was deleted.

19 changes: 13 additions & 6 deletions docs/getting-started/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,19 @@ sidebar_position: 0

# Intro

Let's start with a quick visual demo of how the installation and main menu works.
There are two ways to get started with Spec-Up-T:

<video controls poster={require('@site/static/video/spec-up-t-menu.jpg').default}>
<source src="https://dwarshuis.com/various/spec-up-t/documentation-website/video/spec-up-t-menu.mp4" type="video/mp4" />
Your browser does not support video tags
</video>
- Web-based: create and use a Spec-Up-T installation via GitHub in your browser
- Local installation: create and use a Spec-Up-T installation via your command line

[Link to the video](https://dwarshuis.com/various/spec-up-t/documentation-website/video/spec-up-t-menu.mp4)
## Web-based

The advantage is that it's more straightforward, but it's all slower. For example, retrieving the external credentials is quite simple. However, it does start what is called a “Runner”: a new installation is created on GitHub's servers, and that takes several minutes. After that, the code that retrieves the external credentials is executed. This whole process will take minutes.

On the other hand, modifying a definition is fast: you can use the GitHub web editor.

## Local installation

You can use Spec-Up-T locally, that is, on your computer. It requires basic knowledge of the command line.

First, you install Spec-Up-T via `npx`. After that, you start up a menu via a typed command, and from there, you can enter options.
8 changes: 8 additions & 0 deletions docs/getting-started/local-installation/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "Local Installation",
"position": 1,
"link": {
"type": "generated-index",
"description": "Local Installation."
}
}
8 changes: 0 additions & 8 deletions docs/getting-started/no-installation/_category_.json

This file was deleted.

8 changes: 8 additions & 0 deletions docs/getting-started/web-based/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "Web-based",
"position": 0,
"link": {
"type": "generated-index",
"description": "Web-based."
}
}
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/introduction/target-audience.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,6 @@ Spec-Up-<span className="rotate">T</span> is based on **Spec-Up**, and some of t

:::tip

If you aren't contributing to an existing Spec-Up-T project and want to create one yourself, you will have to install Spec-Up-T to start using it. Go straight to the [installation section](../getting-started/installation/installation.md) for instructions. If you are contributing to an existing Spec-Up-T project you can contribute to content directly within GitHub's web editor (for example) by editing and adding the appropriate markdown files.
If you aren't contributing to an existing Spec-Up-T project and want to create one yourself, you will have to install Spec-Up-T to start using it. Go straight to the [installation section](../getting-started/local-installation/installation.md) for instructions. If you are contributing to an existing Spec-Up-T project you can contribute to content directly within GitHub's web editor (for example) by editing and adding the appropriate markdown files.

:::
2 changes: 1 addition & 1 deletion docs/user-interface-overview/command-line-menu.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Still, it can be confusing. And if you're used to a regular application you cont
Currently, the menu is only tested on MacOs and has not been tested on Windows OS.
:::

Assuming you already [installed](../getting-started/installation/installation.md) Spec-Up-T, here you find further instructions.
Assuming you already [installed](../getting-started/local-installation/installation.md) Spec-Up-T, here you find further instructions.

To start, run this command in the terminal:

Expand Down

0 comments on commit 192d168

Please sign in to comment.