File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 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
Original file line number Diff line number Diff line change 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
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 _ /}
Original file line number Diff line number Diff 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 )
You can’t perform that action at this time.
0 commit comments