Skip to content

Commit 4998d06

Browse files
authored
Merge branch 'main' into feat/rust-docs
2 parents fb5a877 + 9337c73 commit 4998d06

File tree

8 files changed

+21
-49
lines changed

8 files changed

+21
-49
lines changed

.github/workflows/markdown-check.yml

-14
This file was deleted.

.github/workflows/spell-check.yml

-14
This file was deleted.

.markdownlint.jsonc

+1-1
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@
187187
},
188188
// MD042/no-empty-links - No empty links
189189
"MD042": true,
190-
// MD043/required-headings/required-headers - Required heading structure
190+
// MD043/required-headings/required-headings - Required heading structure
191191
"MD043": {
192192
// List of headings
193193
"headings": [

.vscode/tasks.recommended.json

+5-5
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
{
55
"label": "CI - Recursive Markdown Lint - Check",
66
"type": "shell",
7-
"command": "earthly -P +markdown-check",
7+
"command": "earthly -P +check-markdown",
88
"problemMatcher": {
9-
"owner": "markdown-check",
9+
"owner": "check-markdown",
1010
"pattern": {
1111
"regexp": "(\\S+):(\\d+):(\\d+)\\s(.+)",
1212
"file": 1,
@@ -24,7 +24,7 @@
2424
"type": "shell",
2525
"command": "earthly -P +markdown-check-fix",
2626
"problemMatcher": {
27-
"owner": "markdown-check",
27+
"owner": "markdown-check-fix",
2828
"pattern": {
2929
"regexp": "(\\S+):(\\d+):(\\d+)\\s(.+)",
3030
"file": 1,
@@ -40,9 +40,9 @@
4040
{
4141
"label": "CI - Recursive Spell Check",
4242
"type": "shell",
43-
"command": "earthly -P +spell-check",
43+
"command": "earthly -P +check-spelling",
4444
"problemMatcher": {
45-
"owner": "spell-check",
45+
"owner": "check-spelling",
4646
"pattern": {
4747
"regexp": "([\\S+]+):(\\d+):(\\d+)\\s-\\s(.+)",
4848
"file": 1,

Earthfile

+12-12
Original file line numberDiff line numberDiff line change
@@ -5,24 +5,24 @@ FROM debian:stable-slim
55

66
# cspell: words livedocs sitedocs
77

8-
markdown-check:
9-
# Check Markdown in this repo.
10-
LOCALLY
11-
12-
DO github.com/input-output-hk/catalyst-ci/earthly/mdlint:v2.0.9+MDLINT_LOCALLY --src=$(echo ${PWD})
8+
# check-markdown markdown check using catalyst-ci.
9+
check-markdown:
10+
DO github.com/input-output-hk/catalyst-ci/earthly/mdlint:v2.0.10+CHECK
1311

12+
# markdown-check-fix markdown check and fix using catalyst-ci.
1413
markdown-check-fix:
15-
# Check Markdown in this repo.
1614
LOCALLY
1715

18-
DO github.com/input-output-hk/catalyst-ci/earthly/mdlint:v2.0.9+MDLINT_LOCALLY --src=$(echo ${PWD}) --fix=--fix
16+
DO github.com/input-output-hk/catalyst-ci/earthly/mdlint:v2.0.10+MDLINT_LOCALLY --src=$(echo ${PWD}) --fix=--fix
1917

20-
spell-check:
21-
# Check spelling in this repo.
22-
LOCALLY
18+
# check-spelling Check spelling in this repo inside a container.
19+
check-spelling:
20+
DO github.com/input-output-hk/catalyst-ci/earthly/cspell:v2.0.10+CHECK
21+
22+
check:
23+
BUILD +check-spelling
24+
BUILD +check-markdown
2325

24-
DO github.com/input-output-hk/catalyst-ci/earthly/cspell:v2.0.9+CSPELL_LOCALLY --src=$(echo ${PWD})
25-
2626
repo-docs:
2727
# Create artifacts of extra files we embed inside the documentation when its built.
2828
FROM scratch

docs/src/appendix/important/coc.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,5 @@ title: Code of Conduct
44
---
55

66
<!-- markdownlint-disable first-line-h1 -->
7-
<!-- markdownlint-disable required-headers -->
7+
<!-- markdownlint-disable required-headings -->
88
{{ include_file('includes/repo/CODE_OF_CONDUCT.md') }}

docs/src/appendix/important/contributing.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,5 @@ icon: material/pen-plus
33
---
44

55
<!-- markdownlint-disable first-line-h1 -->
6-
<!-- markdownlint-disable required-headers -->
6+
<!-- markdownlint-disable required-headings -->
77
{{ include_file('includes/repo/CONTRIBUTING.md') }}

docs/src/appendix/important/security.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,5 @@ icon: material/security
33
---
44

55
<!-- markdownlint-disable first-line-h1 -->
6-
<!-- markdownlint-disable required-headers -->
6+
<!-- markdownlint-disable required-headings -->
77
{{ include_file('includes/repo/SECURITY.md') }}

0 commit comments

Comments
 (0)