Skip to content

Commit ac23d01

Browse files
Add helper Text
1 parent 5cb7bc9 commit ac23d01

1 file changed

Lines changed: 51 additions & 0 deletions

File tree

src/app/_components/HelpModal.tsx

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -407,9 +407,60 @@ export function HelpModal({ isOpen, onClose, initialSection = 'server-settings'
407407
<li><strong>Update Status:</strong> Show only scripts with available updates</li>
408408
<li><strong>Search Query:</strong> Search within script names and descriptions</li>
409409
<li><strong>Categories:</strong> Filter by specific script categories</li>
410+
<li><strong>Repositories:</strong> Filter scripts by repository source (only shown when multiple repositories are enabled). Click repository buttons to toggle visibility of scripts from that repository.</li>
410411
</ul>
411412
</div>
412413

414+
<div className="p-4 border border-border rounded-lg">
415+
<h4 className="font-medium text-foreground mb-2">Repository Management</h4>
416+
<p className="text-sm text-muted-foreground mb-3">
417+
Scripts are organized by repositories (GitHub repositories). You can add custom repositories or manage existing ones in General Settings.
418+
</p>
419+
420+
<div className="space-y-3">
421+
<div>
422+
<h5 className="font-medium text-foreground mb-1 text-sm">Repository Structure</h5>
423+
<p className="text-sm text-muted-foreground mb-2">
424+
For a repository to work with this system, it must follow this structure:
425+
</p>
426+
<ul className="text-xs text-muted-foreground space-y-1 ml-4 list-disc">
427+
<li><strong>JSON files:</strong> Must be located in a <code className="bg-muted px-1 rounded">frontend/public/json/</code> folder at the repository root</li>
428+
<li><strong>Script files:</strong> Must be organized in subdirectories:
429+
<ul className="ml-4 mt-1 space-y-0.5 list-disc">
430+
<li><code className="bg-muted px-1 rounded">ct/</code> - Container scripts</li>
431+
<li><code className="bg-muted px-1 rounded">install/</code> - Installation scripts</li>
432+
<li><code className="bg-muted px-1 rounded">tools/</code> - Tool scripts</li>
433+
<li><code className="bg-muted px-1 rounded">vm/</code> - Virtual machine scripts</li>
434+
</ul>
435+
</li>
436+
</ul>
437+
</div>
438+
439+
<div>
440+
<h5 className="font-medium text-foreground mb-1 text-sm">Default Repositories</h5>
441+
<ul className="text-xs text-muted-foreground space-y-1 ml-4 list-disc">
442+
<li><strong>Main Repository (ProxmoxVE):</strong> The primary repository, enabled by default. This repository cannot be deleted.</li>
443+
<li><strong>Dev Repository (ProxmoxVED):</strong> Development/testing repository, disabled by default. This repository cannot be deleted.</li>
444+
</ul>
445+
</div>
446+
447+
<div>
448+
<h5 className="font-medium text-foreground mb-1 text-sm">Enable vs Disable</h5>
449+
<ul className="text-xs text-muted-foreground space-y-1 ml-4 list-disc">
450+
<li><strong>Enabled:</strong> Scripts from this repository are included in the Available Scripts tab and will be synced when you sync repositories.</li>
451+
<li><strong>Disabled:</strong> Scripts from this repository are excluded from the Available Scripts tab and will not be synced. Scripts already downloaded from a disabled repository remain on your system but won&apos;t appear in the list.</li>
452+
</ul>
453+
</div>
454+
455+
<div>
456+
<h5 className="font-medium text-foreground mb-1 text-sm">Repository Filter Buttons</h5>
457+
<p className="text-xs text-muted-foreground">
458+
When multiple repositories are enabled, filter buttons appear in the filter bar. Click a repository button to toggle showing/hiding scripts from that repository. Active buttons are highlighted. This allows you to quickly focus on scripts from specific repositories.
459+
</p>
460+
</div>
461+
</div>
462+
</div>
463+
413464
<div className="p-4 border border-border rounded-lg">
414465
<h4 className="font-medium text-foreground mb-2">Script Actions</h4>
415466
<ul className="text-sm text-muted-foreground space-y-2">

0 commit comments

Comments
 (0)