Skip to content

Commit 758be64

Browse files
WH-2099RiskeyL
andauthored
fix: block internal files from mintlify publish (#744)
* fix: block internal files from mintlify publish * fix: restore missing rules in AGENTS.md from CLAUDE.md --------- Co-authored-by: RiskeyL <7a8y@163.com>
1 parent b6f87ac commit 758be64

3 files changed

Lines changed: 21 additions & 56 deletions

File tree

.mintignore

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,12 @@
1-
writing-guides/
2-
tools/translate/config.json
1+
# Root-level internal instructions
2+
/AGENTS.md
3+
/CLAUDE.md
4+
5+
# Internal workflow and tooling directories
6+
/.githooks/
7+
/tools/
8+
/writing-guides/
9+
10+
# Non-public utility files under public asset directories
11+
/assets/migrate_weaviate_collections.py
12+
/logo/convertor.html

AGENTS.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Dify Documentation — AI Agent Instructions
22

3+
Documentation for Dify, built with Mintlify. English is the source language; Chinese and Japanese translations are generated automatically. Exception: `en/self-host/configuration/environments.mdx` is excluded from the translation pipeline and must be translated manually.
4+
35
For documentation tasks, read these guides before starting:
46

57
1. `writing-guides/style-guide.md` — Voice, tone, writing patterns
@@ -10,11 +12,12 @@ For task-specific guidance, see `writing-guides/index.md`.
1012

1113
## Key Rules
1214

13-
- Write in English only, except when specifically optimizing Chinese
14-
or Japanese translations.
15-
- Only edit the English section in `docs.json`. Translation sections sync
16-
automatically.
15+
- Write in English only, except when specifically optimizing Chinese or Japanese translations.
16+
- Only edit the English section in `docs.json`. Translation sections sync automatically.
1717
- MDX files require `title` and `description` in YAML frontmatter.
18+
- When writing about a feature, verify behavior against the Dify codebase, not just existing docs. Existing docs may be outdated.
19+
- For new features, the user may specify a development branch. Code on development branches may be in flux—when behavior is ambiguous, ask rather than assume.
20+
- When adding or updating internal-only instructions, tooling, configs, or other non-public files, ensure all paths that should not be exposed by Mintlify are covered in `.mintignore`.
1821
- Never use `--no-verify` when committing.
1922

2023
## Repository Structure
@@ -41,4 +44,4 @@ mintlify dev Local preview at localhost:3000
4144
| `refactor` | Reorganization without content changes | `refactor: restructure knowledge base section` |
4245
| `translate` | Translation additions or updates | `translate: update Japanese workflow pages` |
4346
| `style` | Formatting-only changes | `style: fix heading levels in plugin guide` |
44-
| `chore` | Dependencies, config | `chore: bump mintlify to 4.0.710` |
47+
| `chore` | Dependencies, config | `chore: bump mintlify to 4.0.710` |

CLAUDE.md

Lines changed: 0 additions & 49 deletions
This file was deleted.

CLAUDE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
AGENTS.md

0 commit comments

Comments
 (0)