Skip to content

Commit 7e1d094

Browse files
Copilotleofang
andcommitted
Replace duplicated Mermaid content with file reference and update regeneration instructions
Co-authored-by: leofang <5534781+leofang@users.noreply.github.com>
1 parent 81f4543 commit 7e1d094

2 files changed

Lines changed: 33 additions & 81 deletions

File tree

CONTRIBUTING.md

Lines changed: 1 addition & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -95,84 +95,7 @@ The CUDA Python project uses a comprehensive CI pipeline that builds, tests, and
9595

9696
![CUDA Python CI Pipeline Flow](ci/ci-pipeline.svg)
9797

98-
Alternative Mermaid diagram representation:
99-
100-
```mermaid
101-
flowchart TD
102-
%% Trigger Events
103-
subgraph TRIGGER["🔄 TRIGGER EVENTS"]
104-
T1["• Push to main branch<br/>• Push to pull-request/* branches"]
105-
T2["• Pull request<br/>• Manual workflow dispatch"]
106-
T1 --- T2
107-
end
108-
109-
%% Build Stage
110-
subgraph BUILD["🔨 BUILD STAGE"]
111-
subgraph BUILD_PLATFORMS["Parallel Platform Builds"]
112-
B1["linux-64<br/>(Self-hosted)"]
113-
B2["linux-aarch64<br/>(Self-hosted)"]
114-
B3["win-64<br/>(GitHub-hosted)"]
115-
end
116-
BUILD_DETAILS["• Python versions: 3.9, 3.10, 3.11, 3.12, 3.13<br/>• CUDA version: 13.0.0 (build-time)<br/>• Components: cuda-core, cuda-bindings,<br/> cuda-pathfinder, cuda-python"]
117-
end
118-
119-
%% Artifact Storage
120-
subgraph ARTIFACTS["📦 ARTIFACT STORAGE"]
121-
subgraph GITHUB_ARTIFACTS["GitHub Artifacts"]
122-
GA1["• Wheel files (.whl)<br/>• Test artifacts<br/>• Documentation<br/>(30-day retention)"]
123-
end
124-
subgraph GITHUB_CACHE["GitHub Cache"]
125-
GC1["• Mini CTK cache"]
126-
end
127-
end
128-
129-
%% Test Stage
130-
subgraph TEST["🧪 TEST STAGE"]
131-
subgraph TEST_PLATFORMS["Parallel Platform Tests"]
132-
TS1["linux-64<br/>(Self-hosted)"]
133-
TS2["linux-aarch64<br/>(Self-hosted)"]
134-
TS3["win-64<br/>(GitHub-hosted)"]
135-
end
136-
TEST_DETAILS["• Download wheels from artifacts<br/>• Test against multiple CUDA runtime versions<br/>• Run Python unit tests, Cython tests, examples"]
137-
ARTIFACT_FLOWS["Artifact Flows:<br/>• cuda-pathfinder: main → backport<br/>• cuda-bindings: backport → main"]
138-
end
139-
140-
%% Release Pipeline
141-
subgraph RELEASE["🚀 RELEASE PIPELINE"]
142-
subgraph RELEASE_STAGES["Sequential Release Steps"]
143-
R1["Validation<br/>• Artifact integrity<br/>• Git tag verification"]
144-
R2["Publishing<br/>• PyPI/TestPyPI<br/>• Component or all releases"]
145-
R3["Documentation<br/>• GitHub Pages<br/>• Release notes"]
146-
R1 --> R2 --> R3
147-
end
148-
RELEASE_DETAILS["• Manual workflow dispatch with run ID<br/>• Supports individual component or full releases"]
149-
end
150-
151-
%% Main Flow
152-
TRIGGER --> BUILD
153-
BUILD --> ARTIFACTS
154-
ARTIFACTS --> TEST
155-
TEST --> RELEASE
156-
157-
%% Artifact Flow Arrows (Cache Reuse)
158-
GITHUB_CACHE -.->|"mini CTK reuse"| BUILD
159-
160-
%% Artifact Flow Arrows (Wheel Fetch)
161-
GITHUB_ARTIFACTS -.->|"wheel fetch"| RELEASE
162-
163-
%% Styling
164-
classDef triggerStyle fill:#e8f4fd,stroke:#2196F3,stroke-width:2px,color:#1976D2
165-
classDef buildStyle fill:#f3e5f5,stroke:#9C27B0,stroke-width:2px,color:#7B1FA2
166-
classDef artifactStyle fill:#fff3e0,stroke:#FF9800,stroke-width:2px,color:#F57C00
167-
classDef testStyle fill:#e8f5e8,stroke:#4CAF50,stroke-width:2px,color:#388E3C
168-
classDef releaseStyle fill:#ffebee,stroke:#f44336,stroke-width:2px,color:#D32F2F
169-
170-
class TRIGGER,T1,T2 triggerStyle
171-
class BUILD,BUILD_PLATFORMS,B1,B2,B3,BUILD_DETAILS buildStyle
172-
class ARTIFACTS,GITHUB_ARTIFACTS,GITHUB_CACHE,GA1,GC1 artifactStyle
173-
class TEST,TEST_PLATFORMS,TS1,TS2,TS3,TEST_DETAILS,ARTIFACT_FLOWS testStyle
174-
class RELEASE,RELEASE_STAGES,R1,R2,R3,RELEASE_DETAILS releaseStyle
175-
```
98+
Alternative Mermaid diagram representation ([ci/ci-pipeline.mmd](ci/ci-pipeline.mmd)):
17699

177100
### Pipeline Execution Details
178101

ci/.ci-pipeline-regen.txt

Lines changed: 32 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,18 +52,47 @@ This file contains the prompt and requirements for regenerating ci-pipeline.svg
5252
- Additional artifact flow arrows (dashed, orange #FF9800):
5353
- From GitHub Cache (mini CTK) back to Build Stage with "mini CTK reuse" label
5454
- From GitHub Artifacts (wheels) to Release Pipeline with "wheel fetch" label
55-
- Arrow marker definition with hand-drawn style
55+
- Arrow marker definition with hand-drawn style (orange arrow heads, not black)
5656
- Use stroke-dasharray="5,3" for artifact flow arrows
5757

58+
## Critical Arrow Positioning Requirements (UPDATED)
59+
**IMPORTANT**: Arrows must NOT overlap with stage boxes. Ensure proper clearance:
60+
61+
1. **Mini CTK reuse arrow** (GitHub Cache → Build Stage):
62+
- Arrow endpoint Y coordinate must be BELOW the Build Stage box edge (y=292)
63+
- Use y=295 or greater for the endpoint to ensure no overlap
64+
- Position "mini CTK reuse" text to the RIGHT of the arrow (not left) for less visual clutter
65+
- Text color should be orange (#FF9800) to match arrow
66+
67+
2. **Wheel fetch arrow** (GitHub Artifacts → Release Pipeline):
68+
- Arrow endpoint Y coordinate must be ABOVE the Release Pipeline box edge (y=652)
69+
- Use y=645 or smaller for the endpoint to provide proper margin
70+
- Position "wheel fetch" text between Test Stage and Release Pipeline boxes
71+
- Text should be to the LEFT of the arrow for better spacing
72+
73+
## Font Size Requirements (UPDATED)
74+
- ALL text labels must use consistent 12pt font size for readability
75+
- No 9pt text - this is too small and hard to read
76+
- Title: 16pt, Stage headers: 14pt, All other text: 12pt
77+
5878
## Key Features
5979
- All boxes use rough, hand-drawn paths (not perfect rectangles)
6080
- Text should be properly sized and positioned within boxes
6181
- Platform boxes within each stage should be clearly separated
6282
- Maintain consistent spacing and alignment
63-
- Use appropriate font sizes: 16pt title, 14pt stage headers, 12pt platform names, 11pt details, 9-10pt smaller text
83+
- Orange arrow heads must match the orange arrow color
6484

6585
## Text Positioning
6686
- Use text-anchor="middle" for centered headers
6787
- Use text-anchor="start" for left-aligned bullet points
6888
- Ensure all text fits within their enclosing boxes
69-
- Use transforms for angled text labels on artifact flow arrows
89+
- Use transforms for angled text labels on artifact flow arrows
90+
- Artifact flow arrow text positioning is critical - follow positioning requirements above
91+
92+
## Recent Manual Adjustments Applied
93+
- Fixed arrow endpoint positioning to prevent overlap with stage boxes
94+
- Moved mini CTK reuse arrow endpoint from y=285 to y=295
95+
- Moved wheel fetch arrow endpoint from y=650 to y=645
96+
- Repositioned text labels for better visual separation
97+
- Standardized all text to 12pt font size for consistency
98+
- Changed arrow heads from black to orange to match arrow color

0 commit comments

Comments
 (0)