Skip to content

Commit bc64be7

Browse files
ymc9ymc9
committed
fix: add release notes html
1 parent e07b57a commit bc64be7

2 files changed

Lines changed: 96 additions & 1 deletion

File tree

‎packages/ide/vscode/src/extension/release-notes-manager.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ export class ReleaseNotesManager implements vscode.Disposable {
4141
// Read the release notes HTML file
4242
const releaseNotesPath = vscode.Uri.joinPath(
4343
this.extensionContext.extensionUri,
44-
'dist/res/zmodel-v3-preview-release-notes.html',
44+
'res/zmodel-v3-preview-release-notes.html',
4545
);
4646

4747
const htmlBytes = await vscode.workspace.fs.readFile(releaseNotesPath);

‎packages/language/res/zmodel-v3-preview-release-notes.html‎

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<link href="https://cdn.jsdelivr.net/npm/@vscode/codicons@0.0.40/dist/codicon.min.css" rel="stylesheet" />
5+
6+
<style>
7+
body {
8+
font-family: system-ui, -apple-system, sans-serif;
9+
padding: 20px;
10+
max-width: 800px;
11+
margin: 0 auto;
12+
background-color: var(--vscode-editor-background);
13+
color: var(--vscode-editor-foreground);
14+
}
15+
.header {
16+
background-color: var(--vscode-button-background);
17+
color: var(--vscode-button-foreground);
18+
padding: 20px;
19+
border-radius: 8px;
20+
text-align: center;
21+
margin-bottom: 20px;
22+
}
23+
.feature {
24+
background-color: var(--vscode-textBlockQuote-background);
25+
border: 1px solid var(--vscode-textBlockQuote-border);
26+
padding: 15px;
27+
border-radius: 6px;
28+
margin: 15px 0;
29+
border-left: 4px solid var(--vscode-button-background);
30+
}
31+
.steps {
32+
background-color: var(--vscode-textCodeBlock-background);
33+
padding: 15px;
34+
border-radius: 6px;
35+
margin: 15px 0;
36+
}
37+
a {
38+
color: var(--vscode-textLink-foreground);
39+
text-decoration: none;
40+
}
41+
a:hover {
42+
text-decoration: underline;
43+
color: var(--vscode-textLink-activeForeground);
44+
}
45+
</style>
46+
</head>
47+
<body>
48+
<div class="header">
49+
<h1>🎉 Introducing ZModel Documentation Preview</h1>
50+
<p>Preview documentation directly from your ZModel powered by AI</p>
51+
</div>
52+
53+
<div class="feature">
54+
<h3>📖 What's New</h3>
55+
<p>
56+
You can now preview comprehensive documentation for your ZModel files, just like you would preview a
57+
markdown file.
58+
</p>
59+
</div>
60+
61+
<div class="steps">
62+
<h3>🚀 How to Use</h3>
63+
<ol>
64+
<li>Open your <code>.zmodel</code> file</li>
65+
<li>
66+
Click (<span class="codicon codicon-preview"></span>) in the editor toolbar, or press
67+
<code>Cmd&nbsp;+&nbsp;Shift&nbsp;+&nbsp;V</code> (Mac) or
68+
<code>Ctrl&nbsp;+&nbsp;Shift&nbsp;+&nbsp;V</code> (Windows)
69+
</li>
70+
<li>Sign in with ZenStack (one-time setup)</li>
71+
<li>
72+
Click (<span class="codicon codicon-save"></span>) in the preview toolbar to save the doc, or press
73+
<code>Cmd&nbsp;+&nbsp;Shift&nbsp;+&nbsp;S</code> (Mac) or
74+
<code>Ctrl&nbsp;+&nbsp;Shift&nbsp;+&nbsp;S</code> (Windows)
75+
</li>
76+
</ol>
77+
</div>
78+
79+
<div class="steps">
80+
<h3>💡 Tips</h3>
81+
<ul>
82+
<li>Ensure your zmodel is error-free before generating.</li>
83+
<li>Use your main zmodel file, which will include all imported models, for complete documentation.</li>
84+
<li>
85+
Add clear, descriptive comments in your ZModel. The more context you provide, the better the
86+
results.
87+
</li>
88+
</ul>
89+
</div>
90+
91+
<p style="text-align: center; color: var(--vscode-descriptionForeground); margin-top: 30px">
92+
Happy coding with ZenStack! 🚀<br />
93+
</p>
94+
</body>
95+
</html>

0 commit comments

Comments
 (0)