mirror of
https://gitee.com/johng/gf
synced 2026-06-06 02:25:47 +08:00
94623a19d1
This pull request introduces new and updated prompt and instruction documents for the experimental OPSX workflow system, providing detailed, step-by-step guidance for proposing, applying, archiving, and exploring changes using OpenSpec. The changes standardize workflow guardrails, clarify user interactions, and ensure consistent artifact handling across all major workflow operations. **OPSX Workflow Prompt Additions and Enhancements:** * **Propose Workflow** - Adds `.agents/prompts/opsx/propose.md` outlining how to propose a new change, including artifact creation order, dependency handling, and user input requirements. Emphasizes using schema-defined instructions and templates, and clarifies that context/rules are for internal guidance only. * **Apply Workflow** - Introduces `.agents/prompts/opsx/apply.md` detailing the process for implementing tasks from an OpenSpec change. Covers change selection, context reading, task loop execution, state handling, and output formatting. Includes guardrails for ambiguity, blockers, and minimal change scope. * **Archive Workflow** - Adds `.agents/prompts/opsx/archive.md` specifying the process for archiving completed changes, including artifact/task completion checks, delta spec sync assessment, user prompts for incomplete work, and summary output. Ensures robust handling of archive naming conflicts and user confirmations. * **Explore Mode** - Adds `.agents/prompts/opsx/explore.md` describing "explore mode" for non-implementation discovery, problem investigation, and requirements clarification. Outlines stance, behaviors, and guardrails for thinking and artifact capture without code changes. **Documentation Standardization:** * **Markdown Formatting Standards** - Adds `.agents/instructions/markdown-format.instructions.md` to standardize markdown document formatting, including heading levels, code block usage, list formatting, and language-specific punctuation rules for improved clarity and consistency.
1.7 KiB
1.7 KiB
name, description, applyTo
| name | description | applyTo |
|---|---|---|
| Standardize markdown document formatting | Standardize the formatting of all markdown documents to keep structure clear, content readable, and the overall quality and user experience consistent. This document explains requirements for heading levels, paragraph formatting, code block usage, list formatting, and image and link insertion so authors can follow a unified style that is easier to read and maintain. | *.{md,MD} |
Primary Formatting Requirements
- Keywords or specialized terms in the document must be formatted with inline code, for example
RuntimeClass,containerd,GPU, andAI. - In Chinese text, do not add spaces around inline code.
- For technical articles, review the generated content before finalizing it to ensure the material is technically accurate and contains no incorrect technical descriptions.
- When the generated content is too large, split it into multiple tasks to avoid exceeding model output limits and causing the workflow to fail.
Detailed Content Requirements
- When documenting parameters or configuration items for a component or project, prefer tables when practical, and keep tables short enough to avoid horizontal scrolling during normal reading.
- In Chinese paragraphs, use full-width punctuation rather than half-width punctuation, for example
，instead of,and；instead of;. - Use
mermaidfor architecture diagrams, flowcharts, and similar visuals. If you need line breaks insidemermaid, use<br/>instead of\n. - If a code block is not a
mermaiddiagram and instead uses box-drawing characters such as┌─,┐,┤, or│, keep the content in English so the layout stays aligned. - Do not use
---as a separator between paragraphs.