mirror of
https://github.com/infiniflow/ragflow.git
synced 2026-08-08 08:28:02 +08:00
fix: split wiki template instruction and example (#17891)
This commit is contained in:
@@ -3,13 +3,14 @@ display_name: Wiki — Graph-based wiki
|
||||
config:
|
||||
kind: wiki
|
||||
plan: yes
|
||||
example: |
|
||||
instruction: |
|
||||
- Each page must be a proper encyclopedic article, NOT a flat bullet list:
|
||||
- 1. Opening paragraph (2-4 sentences defining what this is). No heading.
|
||||
- 2. Sections with H2 headings, each starting with prose before sub-bullets.
|
||||
- 3. Bold key terms on first use; link them with [[ ]] wikilinks.
|
||||
- 4. Examples or implications where the source provides them.
|
||||
- 5. ## See also section at the end with wikilinks to highly related pages(less than 12).\n
|
||||
example: |
|
||||
- Page structure could be as following: (Not provided)
|
||||
entity:
|
||||
description: >-
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
instruction: |
|
||||
- Each page must be a proper encyclopedic article, NOT a flat bullet list:
|
||||
- 1. Take prefix ">" or "-" in the "page_example" as instructions to generate the content.
|
||||
- 1. Take prefix ">" or "-" in the "example" as instructions to generate the content.
|
||||
- 2. Sections with H2 headings, each starting with prose before sub-bullets.
|
||||
page_example: |
|
||||
example: |
|
||||
# Tone of voice
|
||||
|
||||
## Principles
|
||||
@@ -39,9 +39,8 @@ page_example: |
|
||||
|
||||
## Dos & Dont's
|
||||
|We say 👍| We don't say 🙅|
|
||||
| :--- | :---: |
|
||||
| :--- | :---: |
|
||||
|Example| Example|
|
||||
|Example| Example|
|
||||
|
||||
topic: marketing
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
|
||||
instruction: |
|
||||
- Each page must be a proper encyclopedic article, NOT a flat bullet list:
|
||||
- 1. Take prefix ">" or "-" in the "page_example" as instructions to generate the content.
|
||||
- 1. Take prefix ">" or "-" in the "example" as instructions to generate the content.
|
||||
- 2. Sections with H2 headings, each starting with prose before sub-bullets.
|
||||
page_example: |
|
||||
example: |
|
||||
# Secret feature(Title)
|
||||
|
||||
## Background & research
|
||||
@@ -17,7 +17,7 @@ page_example: |
|
||||
- List goals
|
||||
- KPIs
|
||||
- What success looks like
|
||||
|
||||
|
||||
## Hypothesis
|
||||
> If we achieve/enable X, then user behavior Y changes in this way leading to positive metrics Z.
|
||||
|
||||
@@ -32,11 +32,11 @@ page_example: |
|
||||
- Requirements
|
||||
- Future evolutions
|
||||
- Out of scope
|
||||
|
||||
|
||||
## Designs and assets
|
||||
> Add any necessary figma project link, hi-fi mockups, SVGs, font files, images, prototypes...
|
||||
|
||||
## Open questions
|
||||
[x] E.g. is this part of the free plan?
|
||||
|
||||
topic: engineering
|
||||
topic: engineering
|
||||
|
||||
@@ -6,5 +6,5 @@ instruction: |
|
||||
- 3. Bold key terms on first use; link them with [[ ]] wikilinks.
|
||||
- 4. Examples or implications where the source provides them.
|
||||
- 5. ## See also section at the end with wikilinks to highly related pages(less than 12).\n
|
||||
page_example: |
|
||||
- (Not provided)
|
||||
example: |
|
||||
- (Not provided)
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
|
||||
instruction: |
|
||||
- Each page must be a proper encyclopedic article, NOT a flat bullet list:
|
||||
- 1. Take prefix ">" or "-" in the "page_example" as instructions to generate the content.
|
||||
- 1. Take prefix ">" or "-" in the "example" as instructions to generate the content.
|
||||
- 2. Sections with H2 headings, each starting with prose before sub-bullets.
|
||||
page_example: |
|
||||
example: |
|
||||
# Competitor analysis(title)
|
||||
|
||||
## Analysis strengths/weaknesses
|
||||
@@ -22,4 +22,4 @@ page_example: |
|
||||
|
||||
## Pricing
|
||||
|
||||
topic: marketing
|
||||
topic: marketing
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
instruction: |
|
||||
- Each page must be a proper encyclopedic article, NOT a flat bullet list:
|
||||
- 1. Take prefix ">" or "-" in the "page_example" as instructions to generate the content.
|
||||
- 1. Take prefix ">" or "-" in the "example" as instructions to generate the content.
|
||||
- 2. Sections with H2 headings, each starting with prose before sub-bullets.
|
||||
page_example: |
|
||||
example: |
|
||||
# Onboarding flow update
|
||||
## Background & research
|
||||
summary(example): 40% of new users aren't activating. By reviewing our onboarding flow we'll help teams better understand the value of the product and activate faster on Slite.
|
||||
@@ -38,4 +38,4 @@ page_example: |
|
||||
Ok("quick_task result")
|
||||
```
|
||||
|
||||
topic: product
|
||||
topic: product
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
instruction: |
|
||||
- Each page must be a proper encyclopedic article, NOT a flat bullet list:
|
||||
- 1. Take prefix ">" or "-" in the "page_example" as instructions to generate the content.
|
||||
- 1. Take prefix ">" or "-" in the "example" as instructions to generate the content.
|
||||
- 2. Sections with H2 headings, each starting with prose before sub-bullets.
|
||||
page_example: |
|
||||
example: |
|
||||
# User interview
|
||||
## Takeaways
|
||||
- The team is still unaware about features x, y, z
|
||||
@@ -24,4 +24,4 @@ page_example: |
|
||||
## Resources
|
||||
> Upload screenshots or video recordings of your interview. Any relevant file exchanged during your conversation can be added too.
|
||||
|
||||
topic: product
|
||||
topic: product
|
||||
|
||||
@@ -233,7 +233,7 @@ class CompilationTemplateService(CommonService):
|
||||
``api/db/init_data/compilation_templates/wiki/*.yaml``.
|
||||
|
||||
Each file contributes one preset dict with ``topic`` /
|
||||
``instruction`` / ``page_example`` fields (plus ``id`` derived
|
||||
``instruction`` / ``example`` fields (plus ``id`` derived
|
||||
from the filename stem so the frontend can key list items
|
||||
even when several presets share the same ``topic`` — which is
|
||||
by design; the UI groups presets by topic).
|
||||
@@ -278,7 +278,7 @@ class CompilationTemplateService(CommonService):
|
||||
"id": os.path.splitext(filename)[0],
|
||||
"topic": str(doc.get("topic") or "").strip(),
|
||||
"instruction": str(doc.get("instruction") or ""),
|
||||
"page_example": str(doc.get("page_example") or ""),
|
||||
"example": str(doc.get("example") or ""),
|
||||
}
|
||||
)
|
||||
return presets
|
||||
|
||||
Reference in New Issue
Block a user