From 6673be77d24d4567aa040d4a40de910664afbe7b Mon Sep 17 00:00:00 2001 From: ci-bot Date: Fri, 1 May 2026 11:37:50 -0700 Subject: [PATCH 1/2] ci: install reusable lint workflow Adds actionlint + prettier --check on PR via topcoder1/ci-workflows. --- .github/workflows/lint.yml | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 .github/workflows/lint.yml diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml new file mode 100644 index 0000000..4f9cc1e --- /dev/null +++ b/.github/workflows/lint.yml @@ -0,0 +1,24 @@ +name: Lint + +# Caller for the reusable lint workflow in topcoder1/ci-workflows. +# Runs actionlint on .github/workflows/*.yml and prettier --check on **/*.md. +# +# To customize per-project, set inputs below. Examples: +# markdown_glob: 'docs/**/*.md' # only lint docs/ markdown +# run_prettier: false # actionlint only + +on: + pull_request: + push: + branches: [main] + +permissions: + contents: read + +jobs: + lint: + uses: topcoder1/ci-workflows/.github/workflows/lint.yml@main + # with: + # markdown_glob: '**/*.md' + # run_actionlint: true + # run_prettier: true From c8829177f0fceb83485e44cd397c52b064915e76 Mon Sep 17 00:00:00 2001 From: ci-bot Date: Fri, 1 May 2026 16:08:54 -0700 Subject: [PATCH 2/2] chore: normalize markdown to prettier defaults Table column padding + emphasis style (`*` -> `_`). No prose reflow. --- AGENTS.md | 10 +++++----- README.md | 1 + 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index cebd973..495936d 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -14,12 +14,12 @@ ## Terminology -{/* Add product-specific terms and preferred usage */} -{/* Example: Use "workspace" not "project", "member" not "user" */} +{/_ Add product-specific terms and preferred usage _/} +{/_ Example: Use "workspace" not "project", "member" not "user" _/} ## Style preferences -{/* Add any project-specific style rules below */} +{/_ Add any project-specific style rules below _/} - Use active voice and second person ("you") - Keep sentences concise — one idea per sentence @@ -29,5 +29,5 @@ ## Content boundaries -{/* Define what should and shouldn't be documented */} -{/* Example: Don't document internal admin features */} +{/_ Define what should and shouldn't be documented _/} +{/_ Example: Don't document internal admin features _/} diff --git a/README.md b/README.md index 4552fbc..03e36de 100644 --- a/README.md +++ b/README.md @@ -52,4 +52,5 @@ Install our GitHub app from your [dashboard](https://dashboard.mintlify.com/sett - If a page loads as a 404: Make sure you are running in a folder with a valid `docs.json`. ### Resources + - [Mintlify documentation](https://mintlify.com/docs)