Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commit807f9f2

Browse files
committed
docs: refine workflow documentation and fix issue creation references
- Update documentation to accurately reflect issue creation is planned but not implemented- Rename OPTIMIZED-WORKFLOW.md to WORKFLOW-ARCHITECTURE.md for clarity- Remove confusing terminology like 'optimized' and 'improved'- Fix inconsistencies between architecture diagram and implementation
1 parenteb0a323 commit807f9f2

File tree

3 files changed

+17
-17
lines changed

3 files changed

+17
-17
lines changed

‎.github/docs/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ The documentation workflow system has a clear separation of concerns with multip
8888
│ │ creation/update│ │ merges to main│ │ on schedule │ │ PR │ │
8989
│ │ • Generates │ │ • Checks links │ │ • Comprehensive │ │ • Basic │ │
9090
│ │ preview links │ │ only │ │ validation │ │ checks │ │
91-
│ │ • Validates docs│ │ • Falls back to │ │ •Creates issues│ │ • Fast │ │
91+
│ │ • Validates docs│ │ • Falls back to │ │ •Planned: issues│ │ • Fast │ │
9292
│ │ • Posts comments│ │ original doc │ │ for problems │ │ feedback│ │
9393
│ └────────┬────────┘ └────────┬────────┘ └────────┬────────┘ └─────┬─────┘ │
9494
│ │ │ │ │ │
@@ -236,7 +236,7 @@ check-xrefs: true # Comprehensive checks
236236
lint-vale:false# Style not critical for weekly checks
237237
gen-preview:false# No preview needed
238238
post-comment:false# No PR to comment on
239-
create-issues:true# Create issues for persistent problems
239+
create-issues:false# Issue creation feature is planned but not implemented yet
240240
fail-on-error:true# Strict validation
241241
```
242242

‎.github/docs/OPTIMIZED-WORKFLOW.md‎renamed to ‎.github/docs/WORKFLOW-ARCHITECTURE.md‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
#OptimizedDocumentation Workflow
1+
#Documentation Workflow Architecture
22

3-
This document explains theoptimizeddocumentation workflow architecture, whichstreamlines validation and preview processes for Coder's documentation.
3+
This document explains the documentation workflow architecture, whichhandles validation and preview processes for Coder's documentation.
44

55
##Architecture Overview
66

7-
Thenewarchitecture is designed with clear separation of concerns,improved error handling, and more efficient processing:
7+
The architecture is designed with clear separation of concerns,strong error handling, and efficient processing:
88

99
```
1010
┌─ Workflow Entry Points ─────────────────────────────────┐
@@ -108,7 +108,7 @@ preset: 'post-merge'
108108
```
109109
110110
- Focuses on link and cross-reference validation
111-
-Creates GitHub issues forbroken links
111+
-Notifies aboutbroken links (issue creation planned)
112112
- No preview generation
113113
114114
### Weekly Preset
@@ -120,7 +120,7 @@ preset: 'weekly'
120120
121121
- Comprehensive link checking of all documentation
122122
- Strict validation with failure on errors
123-
-Creates GitHub issues with detailed diagnostics
123+
-Planned feature: GitHub issues with detailed diagnostics
124124
125125
### CI Preset
126126
@@ -133,34 +133,34 @@ preset: 'ci'
133133
- Minimal dependency requirements
134134
- Fails fast on errors
135135
136-
## KeyImprovements
136+
## KeyFeatures
137137
138-
### 1.Elimination of Duplication
138+
### 1.Centralized Architecture
139139
140140
- Consolidated workflow architecture with single source of truth
141141
- Unified validation reporting and formatting
142142
- Centralized configuration management
143143
144-
### 2.Improved Error Handling
144+
### 2.Robust Error Handling
145145
146146
- Fault-tolerant file detection with multiple fallback mechanisms
147147
- Graceful degradation when steps fail
148148
- Detailed error reporting with fix guidance
149149
150-
### 3.Optimized Performance
150+
### 3.Efficient Processing
151151
152152
- Conditional dependency installation
153153
- Parallel validation where possible
154154
- Focused validation based on context
155155
156-
### 4.Enhanced User Experience
156+
### 4.Developer-Friendly Interface
157157
158158
- Rich PR comments with direct links to documentation changes
159159
- Collapsible sections for detailed information
160160
- Multiple notification channels
161161
- Always-present validation status section with guidance
162162
163-
### 5.Better Maintainability
163+
### 5.Maintainable Design
164164
165165
- Clear separation of concerns between components
166166
- Standardized interfaces between stages
@@ -173,7 +173,7 @@ preset: 'ci'
173173
```yaml
174174
jobs:
175175
docs-check:
176-
uses:./.github/workflows/docs-unified-optimized.yaml
176+
uses:./.github/workflows/docs-unified.yaml
177177
with:
178178
preset:'pr'
179179
```
@@ -183,7 +183,7 @@ jobs:
183183
```yaml
184184
jobs:
185185
docs-check:
186-
uses:./.github/workflows/docs-unified-optimized.yaml
186+
uses:./.github/workflows/docs-unified.yaml
187187
with:
188188
preset:'pr'
189189
check-links:false# Skip link checking for faster results
@@ -195,7 +195,7 @@ jobs:
195195
```yaml
196196
jobs:
197197
docs-check:
198-
uses:./.github/workflows/docs-unified-optimized.yaml
198+
uses:./.github/workflows/docs-unified.yaml
199199
with:
200200
# Explicitly configure everything
201201
lint-markdown:true

‎.github/docs/actions/docs-core/action.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1206,7 +1206,7 @@ runs:
12061206
WARNINGS=""
12071207
FAILURES=""
12081208
1209-
# Group results by status withimproved error handling
1209+
# Group results by status withrobust error handling
12101210
if [ "$RESULTS" != "[]" ] && [ -n "$RESULTS" ]; then
12111211
# Check if RESULTS is valid JSON before parsing
12121212
if echo "$RESULTS" | jq -e . >/dev/null 2>&1; then

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp