Skip to content

Commit 71d4ef1

Browse files
committed
Cleanup documentation
1 parent 9d99576 commit 71d4ef1

21 files changed

+515
-348
lines changed

.claude/commands/analyze-csproj-migration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ Properties defined in .csproj are:
8181
- ❌ NOT visible in Sdk.props
8282
- ✅ VISIBLE in Sdk.targets
8383

84-
See [SDK-PROPERTY-EVALUATION-ANALYSIS.md](../../build/docs/SDK-PROPERTY-EVALUATION-ANALYSIS.md) for detailed explanation.
84+
See build/docs/SDK-GUIDE.md#property-evaluation-order for detailed explanation.
8585

8686
## Example Usage
8787

.claude/commands/build-sdk.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ This is part of the **WIP SDK-style build system rework** on branch `feature/str
9595
- Migrating `Stride.Core.csproj` as proof of concept
9696
- Moving platform/API targeting logic from `sources/targets/` into SDK
9797

98-
**For more details, see:** `build/docs/SDK-WORK-GUIDE.md`
98+
**For more details, see:** `build/docs/SDK-GUIDE.md`
9999

100100
### Important: MSBuild Evaluation Order
101101

@@ -106,6 +106,6 @@ Properties from the .csproj are NOT visible in Sdk.props!
106106
- **Sdk.props** - Set defaults only
107107
- **Sdk.targets** - Check user values and compute derived properties
108108

109-
See [SDK-PROPERTY-EVALUATION-ANALYSIS.md](../../build/docs/SDK-PROPERTY-EVALUATION-ANALYSIS.md) for details.
109+
See build/docs/SDK-GUIDE.md#property-evaluation-order for details.
110110

111111
Report success/failure and list the packages that were built.

.claude/commands/compare-csproj-versions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ fc /b bin\old\Stride.Core.dll bin\new\Stride.Core.dll
159159

160160
The new SDK-style format fixes critical bugs in the old system where properties were checked at the wrong evaluation phase.
161161

162-
See [SDK-PROPERTY-EVALUATION-ANALYSIS.md](../../build/docs/SDK-PROPERTY-EVALUATION-ANALYSIS.md) for detailed explanation.
162+
See build/docs/SDK-GUIDE.md#property-evaluation-order for detailed explanation.
163163

164164
## Example Usage
165165

.claude/commands/sdk-status.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,6 @@ When checking SDK implementation:
5959
- Look for evaluation phase violations from old system
6060
- Confirm StrideRuntime logic is in .targets (fixes old bug)
6161

62-
See [SDK-PROPERTY-EVALUATION-ANALYSIS.md](../../build/docs/SDK-PROPERTY-EVALUATION-ANALYSIS.md) for details.
62+
See build/docs/SDK-GUIDE.md#property-evaluation-order for details.
6363

6464
Report the current state of the SDK work, what's implemented, and what remains to be done.

.claude/commands/summarize-session.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -290,7 +290,7 @@ Sdk.props (before .csproj) → .csproj (user properties) → Sdk.targets (after
290290
291291
**Documentation:**
292292
- CLAUDE.md - Project guidance
293-
- build/docs/SDK-WORK-GUIDE.md - SDK development workflow
293+
- build/docs/SDK-GUIDE.md - SDK development workflow
294294
- build/docs/SDK-PROPERTY-EVALUATION-ANALYSIS.md - Property evaluation analysis
295295
296296
**Migrated Projects:**

CLAUDE.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ rmdir /s /q "%USERPROFILE%\.nuget\packages\stride.sdk.tests" 2>nul
7676
| `presentation/` | WPF-based UI framework |
7777
| `buildengine/` | Asset build pipeline infrastructure |
7878
| `shaders/` | Shader parsing and compilation |
79-
| `sdk/` | MSBuild SDK packages (Stride.Sdk, Stride.Sdk.Editor, Stride.Sdk.Tests) - see [SDK-WORK-GUIDE.md](build/docs/SDK-WORK-GUIDE.md) |
79+
| `sdk/` | MSBuild SDK packages (Stride.Sdk, Stride.Sdk.Editor, Stride.Sdk.Tests) - see [SDK-GUIDE.md](build/docs/SDK-GUIDE.md) |
8080

8181
### Entity-Component System
8282

@@ -122,7 +122,7 @@ Multi-API support through abstraction layer in `Stride.Graphics`:
122122
- **Assets:** `sources/assets/Stride.Core.Assets/`
123123
- **Editor:** `sources/editor/Stride.GameStudio/`
124124
- **Build config:** `sources/sdk/` (SDK packages), `sources/Directory.Build.props`
125-
- **SDK docs:** `build/docs/SDK-WORK-GUIDE.md`
125+
- **SDK docs:** `build/docs/SDK-GUIDE.md`
126126

127127
## Build System
128128

@@ -204,13 +204,13 @@ When a project uses `<Project Sdk="Stride.Sdk">`, MSBuild evaluates files in thi
204204

205205
**Historical note:** The old build system used `<Import Project="..\..\targets\Stride.Core.props" />` after setting properties, which allowed properties to be visible during the import. This workaround pattern is unnecessary with proper SDK design where the evaluation order is standardized.
206206

207-
See [SDK-WORK-GUIDE.md](build/docs/SDK-WORK-GUIDE.md#understanding-property-evaluation-timing) for detailed examples.
207+
See [SDK-GUIDE.md](build/docs/SDK-GUIDE.md#property-evaluation-order) for detailed examples.
208208

209209
### Build Documentation
210210

211211
Comprehensive build system documentation exists in `build/docs/`:
212-
- `SDK-WORK-GUIDE.md` - SDK development workflow
213-
- `SDK-PROPERTY-EVALUATION-ANALYSIS.md` - Property evaluation order analysis
212+
- `SDK-GUIDE.md` - Build system reference
213+
- `SDK-PROPERTY-EVALUATION-ANALYSIS.md` - Property evaluation order analysis (concepts also covered in SDK-GUIDE.md)
214214
- See `feature/build-analysis-and-improvements` branch for detailed analysis
215215

216216
## Coding Guidelines

0 commit comments

Comments
 (0)