diff --git a/.github/styles/DocsGPT/Spelling.yml b/.github/styles/DocsGPT/Spelling.yml new file mode 100644 index 00000000..977b2412 --- /dev/null +++ b/.github/styles/DocsGPT/Spelling.yml @@ -0,0 +1,11 @@ +extends: spelling +level: warning +message: "Did you really mean '%s'?" +ignore: + - "**/node_modules/**" + - "**/dist/**" + - "**/build/**" + - "**/coverage/**" + - "**/public/**" + - "**/static/**" +vocab: DocsGPT diff --git a/.github/styles/config/vocabularies/DocsGPT/accept.txt b/.github/styles/config/vocabularies/DocsGPT/accept.txt new file mode 100644 index 00000000..73859c2b --- /dev/null +++ b/.github/styles/config/vocabularies/DocsGPT/accept.txt @@ -0,0 +1,46 @@ +Ollama +Qdrant +Milvus +Chatwoot +Nextra +VSCode +npm +LLMs +APIs +Groq +SGLang +LMDeploy +OAuth +Vite +LLM +JSONPath +UIs +configs +uncomment +qdrant +vectorstore +docsgpt +llm +GPUs +kubectl +Lightsail +enqueues +chatbot +VSCode's +Shareability +feedbacks +automations +Premade +Signup +Repo +repo +env +URl +agentic +llama_cpp +parsable +SDKs +boolean +bool +hardcode +EOL diff --git a/.github/workflows/vale.yml b/.github/workflows/vale.yml new file mode 100644 index 00000000..a0f8167c --- /dev/null +++ b/.github/workflows/vale.yml @@ -0,0 +1,26 @@ +name: Vale Documentation Linter + +on: + pull_request: + paths: + - 'docs/**/*.md' + - 'docs/**/*.mdx' + - '**/*.md' + - '.vale.ini' + - '.github/styles/**' + +jobs: + vale: + runs-on: ubuntu-latest + steps: + - name: Checkout code + uses: actions/checkout@v4 + + - name: Vale linter + uses: errata-ai/vale-action@v2 + with: + files: docs + fail_on_error: false + version: 3.0.5 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.vale.ini b/.vale.ini new file mode 100644 index 00000000..c1aeeca7 --- /dev/null +++ b/.vale.ini @@ -0,0 +1,5 @@ +MinAlertLevel = warning +StylesPath = .github/styles + +[*.{md,mdx}] +BasedOnStyles = DocsGPT