Skip to content

Commit 8199848

Browse files
committed
Regenerate docs
1 parent 854967a commit 8199848

File tree

22 files changed

+1984
-39
lines changed

22 files changed

+1984
-39
lines changed

404.html

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -929,6 +929,34 @@
929929

930930

931931

932+
933+
934+
935+
936+
937+
938+
<li class="md-nav__item">
939+
<a href="/glossary/" class="md-nav__link">
940+
941+
942+
943+
<span class="md-ellipsis">
944+
945+
946+
Glossary
947+
948+
949+
950+
</span>
951+
952+
953+
954+
</a>
955+
</li>
956+
957+
958+
959+
932960
</ul>
933961
</nav>
934962

cli/index.html

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1166,6 +1166,34 @@
11661166

11671167

11681168

1169+
1170+
1171+
1172+
1173+
1174+
1175+
<li class="md-nav__item">
1176+
<a href="../glossary/" class="md-nav__link">
1177+
1178+
1179+
1180+
<span class="md-ellipsis">
1181+
1182+
1183+
Glossary
1184+
1185+
1186+
1187+
</span>
1188+
1189+
1190+
1191+
</a>
1192+
</li>
1193+
1194+
1195+
1196+
11691197
</ul>
11701198
</nav>
11711199

concepts/index.html

Lines changed: 36 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -684,10 +684,10 @@
684684
</li>
685685

686686
<li class="md-nav__item">
687-
<a href="#project" class="md-nav__link">
687+
<a href="#source-artifact" class="md-nav__link">
688688
<span class="md-ellipsis">
689689

690-
Project
690+
Source Artifact
691691

692692
</span>
693693
</a>
@@ -1117,6 +1117,34 @@
11171117

11181118

11191119

1120+
1121+
1122+
1123+
1124+
1125+
1126+
<li class="md-nav__item">
1127+
<a href="../glossary/" class="md-nav__link">
1128+
1129+
1130+
1131+
<span class="md-ellipsis">
1132+
1133+
1134+
Glossary
1135+
1136+
1137+
1138+
</span>
1139+
1140+
1141+
1142+
</a>
1143+
</li>
1144+
1145+
1146+
1147+
11201148
</ul>
11211149
</nav>
11221150

@@ -1391,10 +1419,10 @@
13911419
</li>
13921420

13931421
<li class="md-nav__item">
1394-
<a href="#project" class="md-nav__link">
1422+
<a href="#source-artifact" class="md-nav__link">
13951423
<span class="md-ellipsis">
13961424

1397-
Project
1425+
Source Artifact
13981426

13991427
</span>
14001428
</a>
@@ -1525,9 +1553,10 @@ <h3 id="handler-modes">Handler modes<a class="headerlink" href="#handler-modes"
15251553
<li><strong><code>handlers_mode = "replace"</code>:</strong> your handler list completely replaces the preset's handlers for that action.</li>
15261554
<li><strong><code>enabled = false</code> on a handler entry:</strong> disables that specific inherited handler.</li>
15271555
</ul>
1528-
<h2 id="project">Project<a class="headerlink" href="#project" title="Permanent link">&para;</a></h2>
1529-
<p>A <strong>Project</strong> is any directory containing a <code>pyproject.toml</code> with a <code>[tool.finecode]</code> section. FineCode discovers all projects under the workspace root automatically.</p>
1530-
<p>A project may belong to a <strong>workspace</strong> — a directory containing multiple projects. FineCode handles multi-project workspaces transparently: running <code>python -m finecode run lint</code> from the workspace root runs lint in all projects that define it.</p>
1556+
<h2 id="source-artifact">Source Artifact<a class="headerlink" href="#source-artifact" title="Permanent link">&para;</a></h2>
1557+
<p>A <strong>Source Artifact</strong> is a unit of source code that build/publish-style actions operate on. It is identified by a <strong>source artifact definition file</strong> (for example <code>pyproject.toml</code> or <code>package.json</code>). This is what many tools call a “project”, but FineCode uses <strong>source artifact</strong> to be more concrete.</p>
1558+
<p>When a source artifact includes FineCode configuration — a <code>pyproject.toml</code> with a <code>[tool.finecode]</code> section — the Workspace Manager discovers it automatically under the workspace roots provided by the client. Some CLI flags and protocol fields still use the word “project” for compatibility.</p>
1559+
<p>A source artifact may belong to a <strong>workspace</strong> — a set of related source artifacts, often a single directory root but sometimes multiple directories. FineCode handles multi-artifact workspaces transparently: running <code>python -m finecode run lint</code> from the workspace root runs lint in all source artifacts that define it.</p>
15311560
<h2 id="workspace-manager-and-extension-runner">Workspace Manager and Extension Runner<a class="headerlink" href="#workspace-manager-and-extension-runner" title="Permanent link">&para;</a></h2>
15321561
<p>FineCode has two runtime components:</p>
15331562
<h3 id="workspace-manager-wm">Workspace Manager (WM)<a class="headerlink" href="#workspace-manager-wm" title="Permanent link">&para;</a></h3>

configuration/index.html

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1105,6 +1105,34 @@
11051105

11061106

11071107

1108+
1109+
1110+
1111+
1112+
1113+
1114+
<li class="md-nav__item">
1115+
<a href="../glossary/" class="md-nav__link">
1116+
1117+
1118+
1119+
<span class="md-ellipsis">
1120+
1121+
1122+
Glossary
1123+
1124+
1125+
1126+
</span>
1127+
1128+
1129+
1130+
</a>
1131+
</li>
1132+
1133+
1134+
1135+
11081136
</ul>
11091137
</nav>
11101138

development/index.html

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
<link rel="canonical" href="http://localhost:8000/development/">
1414

1515

16-
<link rel="prev" href="../reference/lsp-protocol/">
16+
<link rel="prev" href="../glossary/">
1717

1818

1919
<link rel="next" href="../wm-protocol/">
@@ -942,6 +942,34 @@
942942

943943

944944

945+
946+
947+
948+
949+
950+
951+
<li class="md-nav__item">
952+
<a href="../glossary/" class="md-nav__link">
953+
954+
955+
956+
<span class="md-ellipsis">
957+
958+
959+
Glossary
960+
961+
962+
963+
</span>
964+
965+
966+
967+
</a>
968+
</li>
969+
970+
971+
972+
945973
</ul>
946974
</nav>
947975

getting-started-ide-mcp/index.html

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1070,6 +1070,34 @@
10701070

10711071

10721072

1073+
1074+
1075+
1076+
1077+
1078+
1079+
<li class="md-nav__item">
1080+
<a href="../glossary/" class="md-nav__link">
1081+
1082+
1083+
1084+
<span class="md-ellipsis">
1085+
1086+
1087+
Glossary
1088+
1089+
1090+
1091+
</span>
1092+
1093+
1094+
1095+
</a>
1096+
</li>
1097+
1098+
1099+
1100+
10731101
</ul>
10741102
</nav>
10751103

getting-started/index.html

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1086,6 +1086,34 @@
10861086

10871087

10881088

1089+
1090+
1091+
1092+
1093+
1094+
1095+
<li class="md-nav__item">
1096+
<a href="../glossary/" class="md-nav__link">
1097+
1098+
1099+
1100+
<span class="md-ellipsis">
1101+
1102+
1103+
Glossary
1104+
1105+
1106+
1107+
</span>
1108+
1109+
1110+
1111+
</a>
1112+
</li>
1113+
1114+
1115+
1116+
10891117
</ul>
10901118
</nav>
10911119

0 commit comments

Comments
 (0)