You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Focus on concrete functionality and implementation details with technical reasoning
16
16
- Technical depth over marketing fluff
17
17
- Avoid marketing language like "we're excited", "with open arms", "happy building"
18
18
- CRITICAL: Only include information that is explicitly stated in the release notes - do not expand, infer, or add details
19
-
- Only include code examples, configuration snippets, or commands that are explicitly mentioned in the release notes or you can verify from the Radius code or documentation
20
-
- Do NOT make up code examples following common industry patterns from similar projects if they are not specifically mentioned in the release notes or you cannot verify them from the Radius code or documentation
19
+
- Only include code examples, configuration snippets, or commands that are explicitly mentioned in the release notes
20
+
- Only include information and code samples that you can verify from the Radius code or documentation
21
+
- Do NOT make up code examples following common industry patterns from similar projects if they are not specifically mentioned in the release notes or docs
21
22
- Do NOT make up documentation links - only use links that are specifically mentioned in the release notes or that you can verify from the Radius documentation
23
+
- When including code snippets, ensure they are spaced and formatted correctly for markdown
22
24
- If you cannot verify information from the release notes, do not include it
23
25
- 800-1000 words of substantive technical content
24
26
- Professional, matter-of-fact tone
@@ -30,7 +32,7 @@ Structure:
30
32
- Direct introduction stating what's new in this release and a link to the release
31
33
- Key Features as the main sections, with subheadings for each feature if applicable
32
34
- Technical summary of key features with implementation details and code examples demonstrating usage within the key features.
33
-
-Call out breaking changes within the feature summary if applicable and NOT in a separate section.
35
+
-Mention breaking changes within the feature summary if applicable and DO NOT create a separate section for breaking changes.
34
36
- Conclude with this standard "Learn more and Get Involved" section:
0 commit comments