langgenius/dify-docs
1
0
Fork 0
mirror of https://github.com/langgenius/dify-docs.git synced 2026-07-22 04:15:24 -04:00
Code Issues 10 Packages Projects Releases Wiki Activity

[PR #571] [MERGED] feat: add CI quality gate workflows for documentation #583

New Issue
Closed
opened 2026-02-16 06:16:00 -05:00 by yindo · 0 comments
yindo commented 2026-02-16 06:16:00 -05:00
Owner
Copy Link
Copy Source

📋 Pull Request Information

Original PR: https://github.com/langgenius/dify-docs/pull/571
Author: @lyzno1
Created: 11/29/2025
Status: ✅ Merged
Merged: 12/1/2025
Merged by: @crazywoola

Base: main ← Head: chore/ci

📝 Commits (2)

  • c1667d5 feat: add CI quality gate workflows for documentation
  • 05adc19 chore: remove build-test.yml (redundant with Mintlify App)

📊 Changes

2 files changed (+563 additions, -0 deletions)

View changed files

➕ .github/workflows/quality-check.yml (+288 -0)
➕ .github/workflows/validate-docs-json.yml (+275 -0)

📄 Description

Summary

Add two new GitHub Actions workflows to enforce documentation quality as PR gates:

  • quality-check.yml: Checks frontmatter (title/description), internal links, image paths, code block language tags
  • validate-docs-json.yml: Validates docs.json structure, file references, and language consistency

Why

These workflows complement:

  • Mintlify GitHub App (handles build validation, link-rot, spellcheck)
  • Existing translation automation (sync_docs_*.yml)

By adding quality gates for issues Mintlify App doesn't catch:

  • Missing frontmatter (title/description required by Mintlify)
  • Invalid docs.json references (files that don't exist)
  • Duplicate paths in navigation

Changes

  • quality-check.yml: Validates MDX file quality on PR
  • validate-docs-json.yml: Validates docs.json structure on PR
  • Removed continue-on-error: true to ensure workflows properly fail PRs

Test plan

  • Create a test PR with missing frontmatter → should fail quality-check
  • Create a test PR with invalid docs.json reference → should fail validate-docs-json

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/langgenius/dify-docs/pull/571 **Author:** [@lyzno1](https://github.com/lyzno1) **Created:** 11/29/2025 **Status:** ✅ Merged **Merged:** 12/1/2025 **Merged by:** [@crazywoola](https://github.com/crazywoola) **Base:** `main` ← **Head:** `chore/ci` --- ### 📝 Commits (2) - [`c1667d5`](https://github.com/langgenius/dify-docs/commit/c1667d58040bda698017594089ef4b1582c76e1f) feat: add CI quality gate workflows for documentation - [`05adc19`](https://github.com/langgenius/dify-docs/commit/05adc19f7e9cc6e41b349031f7a8e7d8614a822c) chore: remove build-test.yml (redundant with Mintlify App) ### 📊 Changes **2 files changed** (+563 additions, -0 deletions) <details> <summary>View changed files</summary> ➕ `.github/workflows/quality-check.yml` (+288 -0) ➕ `.github/workflows/validate-docs-json.yml` (+275 -0) </details> ### 📄 Description ## Summary Add two new GitHub Actions workflows to enforce documentation quality as PR gates: - **quality-check.yml**: Checks frontmatter (title/description), internal links, image paths, code block language tags - **validate-docs-json.yml**: Validates docs.json structure, file references, and language consistency ## Why These workflows complement: - **Mintlify GitHub App** (handles build validation, link-rot, spellcheck) - **Existing translation automation** (`sync_docs_*.yml`) By adding quality gates for issues Mintlify App doesn't catch: - Missing frontmatter (title/description required by Mintlify) - Invalid docs.json references (files that don't exist) - Duplicate paths in navigation ## Changes - `quality-check.yml`: Validates MDX file quality on PR - `validate-docs-json.yml`: Validates docs.json structure on PR - Removed `continue-on-error: true` to ensure workflows properly fail PRs ## Test plan - [ ] Create a test PR with missing frontmatter → should fail quality-check - [ ] Create a test PR with invalid docs.json reference → should fail validate-docs-json --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
yindo added the pull-request label 2026-02-16 06:16:00 -05:00
yindo closed this issue 2026-02-16 06:16:00 -05:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
bug
documentation
documentation
enhancement
pull-request
Mirrored from GitHub Pull Request
 question
stale
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
yindo
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: langgenius/dify-docs#583
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?