Skip to content

Commit 29b5a33

Browse files
authored
Merge pull request #301 from Thiht/cleanup-docs
Cleanup docs
2 parents 2f0a267 + 53d4959 commit 29b5a33

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+1432
-9334
lines changed

.dockerignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
.cache/
22
.git/
33
.vscode/
4-
docs/
54
node_modules/
65
tests/

.eslintignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
.parcel-cache/
22
.vscode/
33
build/
4-
docs/.vuepress/dist/
54
node_modules/

.github/workflows/main.yml

Lines changed: 15 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,13 @@ on:
1414
jobs:
1515
lint:
1616
runs-on: ubuntu-latest
17+
timeout-minutes: 5
1718
steps:
1819
- uses: actions/checkout@v4
1920

20-
- id: nvm
21-
run: echo ::set-output name=NVMRC::$(cat .nvmrc)
22-
23-
- uses: actions/setup-node@v3
21+
- uses: actions/setup-node@v4
2422
with:
25-
node-version: '${{ steps.nvm.outputs.NVMRC }}'
23+
node-version-file: .nvmrc
2624
cache: yarn
2725

2826
- run: yarn install --frozen-lockfile
@@ -34,23 +32,22 @@ jobs:
3432
3533
test:
3634
runs-on: ubuntu-latest
35+
timeout-minutes: 5
3736
steps:
3837
- uses: actions/checkout@v4
3938
with:
4039
fetch-depth: 0
4140

42-
- id: nvm
43-
run: echo ::set-output name=NVMRC::$(cat .nvmrc)
44-
45-
- uses: actions/setup-node@v3
41+
- uses: actions/setup-node@v4
4642
with:
47-
node-version: '${{ steps.nvm.outputs.NVMRC }}'
43+
node-version-file: .nvmrc
4844
cache: yarn
4945

46+
5047
- name: Setup Go environment
51-
uses: actions/setup-go@v4
48+
uses: actions/setup-go@v5
5249
with:
53-
go-version: '^1.21.1'
50+
go-version: stable
5451

5552
- run: yarn install --frozen-lockfile
5653

@@ -69,24 +66,22 @@ jobs:
6966

7067
build:
7168
runs-on: ubuntu-latest
69+
timeout-minutes: 5
7270
steps:
7371
- uses: actions/checkout@v4
7472

7573
- id: extract_ref
7674
run: echo ::set-output name=GIT_REF::$(echo ${GITHUB_REF##*/})
7775

78-
- id: nvm
79-
run: echo ::set-output name=NVMRC::$(cat .nvmrc)
80-
81-
- uses: actions/setup-node@v3
76+
- uses: actions/setup-node@v4
8277
with:
83-
node-version: '${{ steps.nvm.outputs.NVMRC }}'
78+
node-version-file: .nvmrc
8479
cache: yarn
8580

8681
- name: Setup Go environment
87-
uses: actions/setup-go@v4
82+
uses: actions/setup-go@v5
8883
with:
89-
go-version: '^1.21.1'
84+
go-version: stable
9085

9186
- run: yarn install --frozen-lockfile
9287

@@ -106,6 +101,7 @@ jobs:
106101
needs: [lint, test, build]
107102
if: startsWith(github.ref, 'refs/tags/')
108103
runs-on: ubuntu-latest
104+
timeout-minutes: 5
109105
steps:
110106
- uses: actions/checkout@v4
111107

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
.vscode/
44
build/
55
coverage/
6-
docs/.vuepress/dist/
76
node_modules/
87
sessions/
98
smocker

README.md

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
<h1 align="center">
2-
<img src="docs/.vuepress/public/logo/logo-horizontal.png" alt="Smocker" height="100" title="Smocker logo by mandyellow" />
2+
<img src="./docs/logo-horizontal.png" alt="Smocker" height="100" title="Smocker logo by mandyellow" />
33
</h1>
44

55
[![CI](https://github.com/Thiht/smocker/actions/workflows/main.yml/badge.svg)](https://github.com/Thiht/smocker/actions/workflows/main.yml)
6-
[![Netlify Status](https://img.shields.io/netlify/61d4e090-b242-419f-8d69-e9dee3d50a37?logo=netlify)](https://app.netlify.com/sites/smocker/deploys)
76
[![Docker Repository](https://img.shields.io/badge/docker-thiht%2Fsmocker-blue?logo=docker)](https://hub.docker.com/r/thiht/smocker)
87
[![Github Release](https://img.shields.io/github/v/release/Thiht/smocker.svg?logo=github)](https://github.com/Thiht/smocker/releases/latest)
98
[![Go Report Card](https://goreportcard.com/badge/github.com/Thiht/smocker)](https://goreportcard.com/report/github.com/Thiht/smocker)
@@ -25,7 +24,6 @@ The documentation is available on [smocker.dev](https://smocker.dev).
2524
- [Development](#development)
2625
- [Backend](#backend)
2726
- [Frontend](#frontend)
28-
- [Documentation](#documentation)
2927
- [Docker](#docker)
3028
- [Caddy](#caddy)
3129
- [HTTPS](#https)
@@ -65,9 +63,9 @@ curl localhost:8081/version
6563

6664
Smocker exposes a configuration user interface. You can access it in your web browser on http://localhost:8081/.
6765

68-
![History](docs/.vuepress/public/screenshots/screenshot-history.png)
66+
![History](docs/screenshots/screenshot-history.png)
6967

70-
![Mocks](docs/.vuepress/public/screenshots/screenshot-mocks.png)
68+
![Mocks](docs/screenshots/screenshot-mocks.png)
7169

7270
## Usage
7371

@@ -160,15 +158,6 @@ The frontend is written with TypeScript and React. You can use the following com
160158
- `yarn test`: execute unit tests
161159
- `yarn test:watch`: execute unit tests, with live reload
162160

163-
### Documentation
164-
165-
The documentation is written in Markdown using [Vuepress](https://vuepress.vuejs.org/). You can use the following commands to manage the documentation:
166-
167-
- `yarn install`: install the dependencies
168-
- `yarn docs:generate`: regenerate documentation screenshots (require the whole application to be started on the default ports)
169-
- `yarn docs:dev`: start the documentation in development mode, with live reload
170-
- `yarn docs:build`: generate the static production documentation
171-
172161
### Docker
173162

174163
The application can be packaged as a standalone Docker image. You can use the following commands to manage the development lifecycle:

docs/.vuepress/config.js

Lines changed: 0 additions & 128 deletions
This file was deleted.
-58.1 KB
Binary file not shown.
-4.26 KB
Binary file not shown.
-11.1 KB
Binary file not shown.
-3.06 KB
Binary file not shown.

0 commit comments

Comments
 (0)