Skip to content

Commit b72d10b

Browse files
Copilotleofang
andcommitted
Fix footnote formatting and convert .txt to .md for pipeline regeneration docs
Co-authored-by: leofang <5534781+leofang@users.noreply.github.com>
1 parent d02a546 commit b72d10b

2 files changed

Lines changed: 12 additions & 5 deletions

File tree

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,4 +207,4 @@ flowchart TD
207207

208208
---
209209

210-
<a id="footnote1">1</a>: `cuda.bindings` follows the contributing guidelines from this repository (`cuda-python`).
210+
<a>1</a>: The `cuda-python` meta package shares the same license and the contributing guidelines as those of `cuda-bindings`.
Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
22
# SPDX-License-Identifier: Apache-2.0
33

4-
CUDA Python CI Pipeline SVG Regeneration Instructions
5-
====================================================
4+
# CUDA Python CI Pipeline SVG Regeneration Instructions
65

7-
This file contains the prompt and requirements for regenerating ci-pipeline.svg with the same styling and content.
6+
This file contains the prompt and requirements for regenerating `ci-pipeline.svg` with the same styling and content.
87

98
## Styling Requirements
9+
1010
- Hand-drawn Excalidraw-style design with rough, sketchy borders
1111
- Comic Sans MS font family for all text
1212
- Imperfect lines and curves that mimic hand-drawn aesthetics
@@ -19,6 +19,7 @@ This file contains the prompt and requirements for regenerating ci-pipeline.svg
1919
- Release Pipeline: #ffebee background, #f44336 border, #D32F2F text
2020

2121
## Content Structure
22+
2223
1. **Title**: "CUDA Python CI Pipeline Flow"
2324

2425
2. **Trigger Events** (top blue box):
@@ -51,6 +52,7 @@ This file contains the prompt and requirements for regenerating ci-pipeline.svg
5152
- Details: Manual workflow dispatch with run ID, Supports individual component or full releases
5253

5354
## Arrow Requirements
55+
5456
- Main flow arrows: Trigger → Build → Artifact → Test → Release
5557
- Additional artifact flow arrows (dashed, orange #FF9800):
5658
- From GitHub Cache (mini CTK) back to Build Stage with "mini CTK reuse" label
@@ -59,6 +61,7 @@ This file contains the prompt and requirements for regenerating ci-pipeline.svg
5961
- Use stroke-dasharray="5,3" for artifact flow arrows
6062

6163
## Critical Arrow Positioning Requirements (UPDATED)
64+
6265
**IMPORTANT**: Arrows must NOT overlap with stage boxes. Ensure proper clearance:
6366

6467
1. **Mini CTK reuse arrow** (GitHub Cache → Build Stage):
@@ -74,28 +77,32 @@ This file contains the prompt and requirements for regenerating ci-pipeline.svg
7477
- Text should be to the LEFT of the arrow for better spacing
7578

7679
## Font Size Requirements (UPDATED)
80+
7781
- ALL text labels must use consistent 12pt font size for readability
7882
- No 9pt text - this is too small and hard to read
7983
- Title: 16pt, Stage headers: 14pt, All other text: 12pt
8084

8185
## Key Features
86+
8287
- All boxes use rough, hand-drawn paths (not perfect rectangles)
8388
- Text should be properly sized and positioned within boxes
8489
- Platform boxes within each stage should be clearly separated
8590
- Maintain consistent spacing and alignment
8691
- Orange arrow heads must match the orange arrow color
8792

8893
## Text Positioning
94+
8995
- Use text-anchor="middle" for centered headers
9096
- Use text-anchor="start" for left-aligned bullet points
9197
- Ensure all text fits within their enclosing boxes
9298
- Use transforms for angled text labels on artifact flow arrows
9399
- Artifact flow arrow text positioning is critical - follow positioning requirements above
94100

95101
## Recent Manual Adjustments Applied
102+
96103
- Fixed arrow endpoint positioning to prevent overlap with stage boxes
97104
- Moved mini CTK reuse arrow endpoint from y=285 to y=295
98105
- Moved wheel fetch arrow endpoint from y=650 to y=645
99106
- Repositioned text labels for better visual separation
100107
- Standardized all text to 12pt font size for consistency
101-
- Changed arrow heads from black to orange to match arrow color
108+
- Changed arrow heads from black to orange to match arrow color

0 commit comments

Comments
 (0)