Skip to content

Commit eed6aff

Browse files
topcoder1ci-bot
andauthored
ci: install reusable lint workflow (#1)
* ci: install reusable lint workflow Adds actionlint + prettier --check on PR via topcoder1/ci-workflows. * chore: normalize markdown to prettier defaults Table column padding + emphasis style (`*` -> `_`). No prose reflow. --------- Co-authored-by: ci-bot <ci@local>
1 parent d37ff1f commit eed6aff

3 files changed

Lines changed: 30 additions & 5 deletions

File tree

.github/workflows/lint.yml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: Lint
2+
3+
# Caller for the reusable lint workflow in topcoder1/ci-workflows.
4+
# Runs actionlint on .github/workflows/*.yml and prettier --check on **/*.md.
5+
#
6+
# To customize per-project, set inputs below. Examples:
7+
# markdown_glob: 'docs/**/*.md' # only lint docs/ markdown
8+
# run_prettier: false # actionlint only
9+
10+
on:
11+
pull_request:
12+
push:
13+
branches: [main]
14+
15+
permissions:
16+
contents: read
17+
18+
jobs:
19+
lint:
20+
uses: topcoder1/ci-workflows/.github/workflows/lint.yml@main
21+
# with:
22+
# markdown_glob: '**/*.md'
23+
# run_actionlint: true
24+
# run_prettier: true

AGENTS.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@
1414

1515
## Terminology
1616

17-
{/* Add product-specific terms and preferred usage */}
18-
{/* Example: Use "workspace" not "project", "member" not "user" */}
17+
{/_ Add product-specific terms and preferred usage _/}
18+
{/_ Example: Use "workspace" not "project", "member" not "user" _/}
1919

2020
## Style preferences
2121

22-
{/* Add any project-specific style rules below */}
22+
{/_ Add any project-specific style rules below _/}
2323

2424
- Use active voice and second person ("you")
2525
- Keep sentences concise — one idea per sentence
@@ -29,5 +29,5 @@
2929

3030
## Content boundaries
3131

32-
{/* Define what should and shouldn't be documented */}
33-
{/* Example: Don't document internal admin features */}
32+
{/_ Define what should and shouldn't be documented _/}
33+
{/_ Example: Don't document internal admin features _/}

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,4 +52,5 @@ Install our GitHub app from your [dashboard](https://dashboard.mintlify.com/sett
5252
- If a page loads as a 404: Make sure you are running in a folder with a valid `docs.json`.
5353

5454
### Resources
55+
5556
- [Mintlify documentation](https://mintlify.com/docs)

0 commit comments

Comments
 (0)