ForgeLM/site/guide.html at development · HodeTech/ForgeLM · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <meta name="viewport" content="width=device-width, initial-scale=1.0, viewport-fit=cover">
  <title data-i18n="meta.title.guide">User Guide — ForgeLM</title>
  <meta name="description" data-i18n-attr="content:meta.desc.guide"
        content="Comprehensive ForgeLM user guide — every feature, every parameter, with copy-pasteable examples.">
  <meta name="theme-color" content="#0a0c12">
  <meta property="og:title" data-i18n-attr="content:meta.title.guide" content="User Guide — ForgeLM">
  <meta property="og:description" data-i18n-attr="content:meta.desc.guide" content="The complete ForgeLM user guide.">
  <meta property="og:type" content="website">
  <meta property="og:image" content="https://forgelm.dev/assets/og.png">
  <meta property="og:url" content="https://forgelm.dev/guide.html">
  <meta property="og:locale" content="en_US">
  <meta property="og:locale:alternate" content="tr_TR">
  <meta property="og:locale:alternate" content="de_DE">
  <meta property="og:locale:alternate" content="fr_FR">
  <meta property="og:locale:alternate" content="es_ES">
  <meta property="og:locale:alternate" content="zh_CN">
  <!-- The site serves a single English-baseline URL per page; locale
       switching is a runtime JS layer (translations.js + data-i18n attrs)
       rather than separate /tr/ /de/ paths. We declare hreflang="en" +
       x-default only — declaring per-locale alternates here would point at
       the same URL and mislead crawlers. -->
  <link rel="alternate" hreflang="en" href="https://forgelm.dev/guide.html">
  <link rel="alternate" hreflang="x-default" href="https://forgelm.dev/guide.html">
  <link rel="canonical" href="https://forgelm.dev/guide.html">
  <link rel="preconnect" href="https://fonts.googleapis.com">
  <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  <link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700;800&amp;family=JetBrains+Mono:wght@400;500;600&amp;display=swap">
  <link rel="icon" href="favicon.ico">
  <link rel="apple-touch-icon" href="apple-touch-icon.png">
  <link rel="stylesheet" href="css/style.css">
  <script src="js/_shared.js" defer></script>
  <script src="js/translations.js" defer></script>
  <script src="js/i18n.js" defer></script>
  <script src="js/usermanuals/_index.js" defer></script>
  <script src="js/usermanuals/en.js"></script>
  <script src="https://cdn.jsdelivr.net/npm/mermaid@10.9.4/dist/mermaid.min.js"
          integrity="sha384-fGOpyux4znQZ+n4tUrYReB2Ulu6K1MtBxIkbHauU09YM1hvCyA5oX9JUc1hRkDEr"
          crossorigin="anonymous"
          referrerpolicy="no-referrer"></script>

  <script type="application/ld+json">
{
  "@context": "https://schema.org",
  "@type": "SoftwareApplication",
  "name": "ForgeLM",
  "applicationCategory": "DeveloperApplication",
  "applicationSubCategory": "MachineLearning",
  "description": "Comprehensive ForgeLM user guide \u2014 every feature, every parameter, with copy-pasteable examples.",
  "url": "https://forgelm.dev/guide.html",
  "downloadUrl": "https://pypi.org/project/forgelm/",
  "operatingSystem": "Linux, macOS, Windows",
  "license": "https://www.apache.org/licenses/LICENSE-2.0",
  "softwareVersion": "0.11.0",
  "offers": {
    "@type": "Offer",
    "price": "0",
    "priceCurrency": "USD"
  },
  "author": {
    "@type": "Organization",
    "name": "ForgeLM",
    "url": "https://forgelm.dev/"
  }
}
  </script>
  <script type="application/ld+json">
{
  "@context": "https://schema.org",
  "@type": "Organization",
  "name": "ForgeLM",
  "url": "https://forgelm.dev/",
  "sameAs": [
    "https://github.com/HodeTech/ForgeLM",
    "https://pypi.org/project/forgelm/"
  ]
}
  </script>
</head>
<body>
<a href="#guide-content" class="skip-link" data-i18n="common.skip_to_main">Skip to main content</a>

<!-- Reading progress bar -->
<progress class="guide-progress" id="guide-progress" max="100" value="0" aria-label="Reading progress" data-i18n-attr="aria-label:guide.progress.label">0</progress>

<nav class="navbar" role="navigation" aria-label="Main">
  <div class="container">
    <a href="index.html" class="nav-brand">
      <span class="nav-brand-mark"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2.2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><path d="M14 6l6 6-6 6"/><path d="M4 12h13"/></svg></span>
      ForgeLM
    </a>
    <button class="nav-hamburger" data-i18n-attr="aria-label:common.btn.menu" aria-label="Menu" aria-expanded="false" aria-controls="primary-nav"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" aria-hidden="true"><line x1="3" y1="6" x2="21" y2="6"/><line x1="3" y1="12" x2="21" y2="12"/><line x1="3" y1="18" x2="21" y2="18"/></svg></button>
    <ul class="nav-menu" id="primary-nav">
      <li><a href="index.html" data-i18n="common.nav.home">Home</a></li>
      <li><a href="features.html" data-i18n="common.nav.features">Features</a></li>
      <li><a href="quickstart.html" data-i18n="common.nav.quickstart">Quickstart</a></li>
      <li><a href="guide.html" class="active" data-i18n="common.nav.guide">Guide</a></li>
      <li><a href="compliance.html" data-i18n="common.nav.compliance">Compliance</a></li>
      <li><a href="contact.html" data-i18n="common.nav.contact">Contact</a></li>
    </ul>
    <div class="nav-actions">
      <div class="lang-toggle">
        <button class="lang-toggle-btn" type="button" aria-haspopup="true" aria-expanded="false" data-i18n-attr="aria-label:common.btn.lang" aria-label="Language">
          <svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><circle cx="12" cy="12" r="10"/><line x1="2" y1="12" x2="22" y2="12"/><path d="M12 2a15 15 0 0 1 4 10 15 15 0 0 1-4 10"/><path d="M12 2a15 15 0 0 0-4 10 15 15 0 0 0 4 10"/></svg>
          <span class="lang-toggle-current">EN</span>
          <svg class="chevron" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2.5" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><polyline points="6 9 12 15 18 9"/></svg>
        </button>
        <ul class="lang-toggle-menu">
          <li><button data-set-lang="en" type="button">English</button></li>
          <li><button data-set-lang="tr" type="button">Türkçe</button></li>
          <li><button data-set-lang="de" type="button">Deutsch</button></li>
          <li><button data-set-lang="fr" type="button">Français</button></li>
          <li><button data-set-lang="es" type="button">Español</button></li>
          <li><button data-set-lang="zh" type="button">中文</button></li>
        </ul>
      </div>
      <button class="theme-toggle" type="button" data-i18n-attr="aria-label:common.btn.theme" aria-label="Toggle theme" aria-pressed="false">
        <svg class="icon-moon" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><path d="M21 12.79A9 9 0 1 1 11.21 3 7 7 0 0 0 21 12.79z"/></svg>
        <svg class="icon-sun" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><circle cx="12" cy="12" r="4"/><path d="M12 2v2M12 20v2M4.93 4.93l1.41 1.41M17.66 17.66l1.41 1.41M2 12h2M20 12h2M4.93 19.07l1.41-1.41M17.66 6.34l1.41-1.41"/></svg>
      </button>
    </div>
  </div>
</nav>

<!-- Mobile sticky bar with hamburger for sidebar + crumb -->
<div class="guide-mobile-bar">
  <button id="guide-mobile-toggle" type="button" aria-label="Open guide navigation">
    <svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" aria-hidden="true"><line x1="3" y1="6" x2="21" y2="6"/><line x1="3" y1="12" x2="21" y2="12"/><line x1="3" y1="18" x2="21" y2="18"/></svg>
    <span data-i18n="guide.mobile.menu">Menu</span>
  </button>
  <span class="crumb" id="guide-mobile-crumb"></span>
</div>

<!-- 3-column shell -->
<div class="guide-layout">

  <!-- Left rail: sections + pages -->
  <aside class="guide-sidebar" id="guide-sidebar" aria-label="Guide sections" data-i18n-attr="aria-label:guide.sidebar.label">
    <div class="guide-sidebar-search-wrap">
      <input
        type="search"
        id="guide-search-trigger"
        class="guide-sidebar-search"
        readonly
        placeholder="Search the guide…"
        data-i18n-attr="placeholder:guide.search.placeholder">
      <span class="guide-sidebar-kbd">⌘K</span>
    </div>
    <nav id="guide-nav" aria-label="User guide"></nav>
  </aside>

  <!-- Main content -->
  <main class="guide-content" id="guide-content" tabindex="-1"></main>

  <!-- Right rail: on-this-page TOC -->
  <aside class="guide-toc" id="guide-toc" aria-label="On this page"></aside>

</div>

<!-- Search overlay (Cmd+K) -->
<dialog class="guide-search-overlay" id="guide-search-overlay" aria-label="Search the guide" data-i18n-attr="aria-label:guide.search.label">
  <div class="guide-search-modal">
    <input
      type="search"
      id="guide-search-input"
      class="guide-search-input"
      placeholder="Search the guide…"
      data-i18n-attr="placeholder:guide.search.placeholder"
      aria-label="Search">
    <ul id="guide-search-results" class="guide-search-results"></ul>
    <div class="guide-search-footer">
      <span><kbd>↑</kbd><kbd>↓</kbd> <span data-i18n="guide.search.kbd_navigate">to navigate</span></span>
      <span><kbd>↵</kbd> <span data-i18n="guide.search.kbd_select">to open</span></span>
      <span><kbd>esc</kbd> <span data-i18n="guide.search.kbd_close">to close</span></span>
    </div>
  </div>
</dialog>

<!-- Footer (compact for guide) -->
<footer class="footer">
  <div class="container">
    <div class="footer-grid">
      <div>
        <div class="footer-brand">
          <span class="nav-brand-mark footer-brand-mark">
            <svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2.2" stroke-linecap="round" stroke-linejoin="round" class="footer-brand-icon" aria-hidden="true">
              <path d="M14 6l6 6-6 6"/><path d="M4 12h13"/>
            </svg>
          </span>
          ForgeLM
        </div>
        <p class="footer-desc" data-i18n="common.footer.brand_desc">Config-driven LLM fine-tuning toolkit.</p>
      </div>

      <div class="footer-col">
        <h4 data-i18n="common.footer.product">Product</h4>
        <ul>
          <li><a href="features.html" data-i18n="common.nav.features">Features</a></li>
          <li><a href="quickstart.html" data-i18n="common.nav.quickstart">Quickstart</a></li>
          <li><a href="compliance.html" data-i18n="common.nav.compliance">Compliance</a></li>
          <li><a href="https://pypi.org/project/forgelm/" target="_blank" rel="noopener">PyPI</a></li>
        </ul>
      </div>

      <div class="footer-col">
        <h4 data-i18n="common.footer.community">Community</h4>
        <ul>
          <li><a href="https://github.com/HodeTech/ForgeLM" target="_blank" rel="noopener">GitHub</a></li>
          <li><a href="https://github.com/HodeTech/ForgeLM/blob/development/CONTRIBUTING.md#your-first-pull-request" target="_blank" rel="noopener" data-i18n="common.footer.contribute">Contribute</a></li>
          <li><a href="https://github.com/HodeTech/ForgeLM/issues" target="_blank" rel="noopener" data-i18n="common.footer.issues">Issues</a></li>
          <li><a href="https://github.com/HodeTech/ForgeLM/discussions" target="_blank" rel="noopener" data-i18n="common.footer.discussions">Discussions</a></li>
          <li><a href="https://github.com/HodeTech/ForgeLM/releases" target="_blank" rel="noopener" data-i18n="common.footer.releases">Releases</a></li>
        </ul>
      </div>

      <div class="footer-col">
        <h4 data-i18n="common.footer.legal">Legal</h4>
        <ul>
          <li><a href="privacy.html" data-i18n="common.footer.privacy">Privacy</a></li>
          <li><a href="terms.html" data-i18n="common.footer.terms">Terms</a></li>
          <li><a href="contact.html" data-i18n="common.footer.contact">Contact</a></li>
          <li><a href="https://opensource.org/licenses/Apache-2.0" target="_blank" rel="noopener">Apache 2.0</a></li>
        </ul>
      </div>
    </div>

    <div class="footer-bottom">
      <span>&copy; 2026 ForgeLM</span>
      <span data-i18n="common.footer.tagline">Built for teams that ship into regulated environments.</span>
    </div>
  </div>
</footer>

<script src="js/main.js"></script>
<script src="js/guide.js"></script>
</body>
</html>