Skip to content

Commit 851e4d8

Browse files
shouzeshouze
committed
feat: promotion polish — docs UX, CLI hyperlinks, completions auto-install
## Docs / VitePress - ComparisonTable: add per-row descriptions, target=_blank links, bump font sizes, fix hover contrast (text stays readable on violet bg) - VersionBadge: bump badge font-size 13→15 px - InstallSection: subtitle and step-label font-size 15→16 px - ProductionCta: body text 15→16 px, replace ↗ emoji with inline SVG arrow (iOS Safari fix), switch button to inline-flex - TestimonialsSection: fix hover border/shadow, replace arrow emoji with SVG, fix cta-btn hover contrast (force color:#fff) - RichFooter: replace ↗ emoji with SVG arrow on fulll.fr link ## CLI / core - help colorizer: colorize all bare https:// URLs in any description line (not only Docs: prefix) - upgrade output: render all post-upgrade URLs in cyan underline via upgradeLink() helper - refreshCompletions: always create completion file (install + refresh), not only overwrite existing ones - output.ts: replay command summary now links to https://fulll.github.io/github-code-search/ ## Tests - output.test.ts: update summary assertion to match new link text - upgrade.test.ts: update refreshCompletions tests to reflect 'always install' behaviour
1 parent ebb77b2 commit 851e4d8

File tree

12 files changed

+284
-51
lines changed

12 files changed

+284
-51
lines changed

‎.vscode/settings.json‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"chat.tools.terminal.autoApprove": {
3+
"/^git checkout -b feat/promotion-polish && git add -A && git diff --cached --stat$/": {
4+
"approve": true,
5+
"matchCommandLine": true
6+
}
7+
}
8+
}

‎docs/.vitepress/theme/ComparisonTable.vue‎

Lines changed: 138 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,69 @@
11
<script setup lang="ts">
22
interface Row {
33
feature: string;
4+
desc: string;
45
gh: boolean;
56
gcs: boolean;
7+
docLink?: string;
68
}
79
810
const ROWS: Row[] = [
9-
{ feature: "Results grouped by repository", gh: false, gcs: true },
10-
{ feature: "Interactive TUI — navigate, select, filter", gh: false, gcs: true },
11-
{ feature: "Fine-grained extract selection", gh: false, gcs: true },
12-
{ feature: "Markdown / JSON output", gh: false, gcs: true },
13-
{ feature: "Replay / CI command", gh: false, gcs: true },
14-
{ feature: "Team-prefix grouping", gh: false, gcs: true },
15-
{ feature: "Syntax highlighting in terminal", gh: false, gcs: true },
16-
{ feature: "Pagination (up to 1 000 results)", gh: true, gcs: true },
11+
{
12+
feature: "Results grouped by repository",
13+
desc: "One block per repo instead of a flat list — fold or unfold at a glance.",
14+
gh: false,
15+
gcs: true,
16+
docLink: "/github-code-search/usage/interactive-mode",
17+
},
18+
{
19+
feature: "Interactive TUI \u2014 navigate, select, filter",
20+
desc: "Arrow-key navigation, path-based filter and live selection without leaving the terminal.",
21+
gh: false,
22+
gcs: true,
23+
docLink: "/github-code-search/usage/interactive-mode",
24+
},
25+
{
26+
feature: "Fine-grained extract selection",
27+
desc: "Cherry-pick individual code extracts; deselected items become \u2014exclude flags automatically.",
28+
gh: false,
29+
gcs: true,
30+
docLink: "/github-code-search/usage/interactive-mode",
31+
},
32+
{
33+
feature: "Markdown / JSON output",
34+
desc: "Export clean Markdown checklists or machine-readable JSON ready for CI scripts.",
35+
gh: false,
36+
gcs: true,
37+
docLink: "/github-code-search/usage/output-formats",
38+
},
39+
{
40+
feature: "Replay / CI command",
41+
desc: "Every session produces a one-liner to reproduce the exact output headlessly in CI.",
42+
gh: false,
43+
gcs: true,
44+
docLink: "/github-code-search/usage/non-interactive-mode",
45+
},
46+
{
47+
feature: "Team-prefix grouping",
48+
desc: "Cluster repos by GitHub team prefix (squad-, chapter-) for org-wide triage.",
49+
gh: false,
50+
gcs: true,
51+
docLink: "/github-code-search/usage/team-grouping",
52+
},
53+
{
54+
feature: "Syntax highlighting in terminal",
55+
desc: "Language-aware token colouring rendered in the TUI \u2014 no browser needed.",
56+
gh: false,
57+
gcs: true,
58+
docLink: "/github-code-search/usage/interactive-mode",
59+
},
60+
{
61+
feature: "Pagination (up to 1\u202f000 results)",
62+
desc: "Both tools auto-paginate the GitHub search API \u2014 up to 1\u202f000 results per query.",
63+
gh: true,
64+
gcs: true,
65+
docLink: "/github-code-search/reference/github-api-limits",
66+
},
1767
];
1868
</script>
1969

@@ -48,7 +98,39 @@ const ROWS: Row[] = [
4898
</thead>
4999
<tbody>
50100
<tr v-for="row in ROWS" :key="row.feature" class="ct-row">
51-
<td class="ct-feature">{{ row.feature }}</td>
101+
<td class="ct-feature">
102+
<a
103+
v-if="row.docLink"
104+
:href="row.docLink"
105+
target="_blank"
106+
rel="noopener noreferrer"
107+
class="ct-feature-link"
108+
>
109+
<span class="ct-feature-title">
110+
{{ row.feature }}
111+
<svg
112+
class="ct-ext-icon"
113+
aria-hidden="true"
114+
width="11"
115+
height="11"
116+
viewBox="0 0 24 24"
117+
fill="none"
118+
stroke="currentColor"
119+
stroke-width="2"
120+
stroke-linecap="round"
121+
stroke-linejoin="round"
122+
>
123+
<line x1="7" y1="17" x2="17" y2="7" />
124+
<polyline points="7 7 17 7 17 17" />
125+
</svg>
126+
</span>
127+
<span class="ct-feature-desc">{{ row.desc }}</span>
128+
</a>
129+
<span v-else class="ct-feature-plain">
130+
<span class="ct-feature-title">{{ row.feature }}</span>
131+
<span class="ct-feature-desc">{{ row.desc }}</span>
132+
</span>
133+
</td>
52134
<td class="ct-cell">
53135
<span v-if="row.gh" class="ct-check">✓</span>
54136
<span v-else class="ct-cross">✗</span>
@@ -109,7 +191,7 @@ const ROWS: Row[] = [
109191
.ct-intro {
110192
margin: 0;
111193
padding: 20px 24px 18px;
112-
font-size: 14px;
194+
font-size: 15.5px;
113195
line-height: 1.7;
114196
color: var(--vp-c-text-2);
115197
border-bottom: 1px solid var(--vp-c-divider);
@@ -160,7 +242,7 @@ thead tr {
160242
}
161243
162244
.ct-tool-name {
163-
font-size: 13px;
245+
font-size: 14px;
164246
font-weight: 600;
165247
white-space: nowrap;
166248
}
@@ -210,12 +292,55 @@ thead tr {
210292
}
211293
212294
.ct-feature {
213-
padding: 14px 24px;
214-
font-size: 14px;
295+
padding: 12px 24px;
296+
font-size: 15px;
215297
color: var(--vp-c-text-1);
216298
line-height: 1.5;
217299
}
218300
301+
.ct-feature-link,
302+
.ct-feature-plain {
303+
display: flex;
304+
flex-direction: column;
305+
gap: 3px;
306+
color: var(--vp-c-text-1);
307+
text-decoration: none;
308+
}
309+
310+
.ct-feature-link:hover {
311+
color: var(--vp-c-text-1);
312+
}
313+
314+
.ct-feature-title {
315+
display: inline-flex;
316+
align-items: center;
317+
gap: 5px;
318+
font-size: 15px;
319+
font-weight: 600;
320+
color: inherit;
321+
}
322+
323+
.ct-feature-desc {
324+
font-size: 13px;
325+
font-weight: 400;
326+
color: var(--vp-c-text-3);
327+
line-height: 1.45;
328+
}
329+
330+
.ct-feature-link:hover .ct-feature-desc {
331+
color: var(--vp-c-text-2);
332+
}
333+
334+
.ct-ext-icon {
335+
opacity: 0.35;
336+
flex-shrink: 0;
337+
transition: opacity 0.15s;
338+
}
339+
340+
.ct-feature-link:hover .ct-ext-icon {
341+
opacity: 0.75;
342+
}
343+
219344
.ct-cell {
220345
padding: 14px 12px;
221346
text-align: center;

‎docs/.vitepress/theme/InstallSection.vue‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -232,7 +232,7 @@ function copySearch() {
232232
233233
.is-subtitle {
234234
margin: 0;
235-
font-size: 15px;
235+
font-size: 16px;
236236
color: var(--vp-c-text-2);
237237
line-height: 1.65;
238238
}
@@ -284,7 +284,7 @@ function copySearch() {
284284
285285
.is-step-label {
286286
margin: 8px 0 10px;
287-
font-size: 15px;
287+
font-size: 16px;
288288
font-weight: 600;
289289
color: var(--vp-c-text-1);
290290
}

‎docs/.vitepress/theme/ProductionCta.vue‎

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,22 @@
4545
target="_blank"
4646
rel="noopener noreferrer"
4747
>
48-
Share your story ↗
48+
<span>Share your story</span>
49+
<svg
50+
class="cta-btn-arrow"
51+
aria-hidden="true"
52+
xmlns="http://www.w3.org/2000/svg"
53+
width="13"
54+
height="13"
55+
viewBox="0 0 24 24"
56+
fill="none"
57+
stroke="currentColor"
58+
stroke-width="2"
59+
stroke-linecap="round"
60+
stroke-linejoin="round"
61+
>
62+
<path d="M7 17L17 7M7 7h10v10" />
63+
</svg>
4964
</a>
5065
</div>
5166
</template>
@@ -133,7 +148,7 @@
133148
134149
.cta-text {
135150
margin: 0;
136-
font-size: 15px;
151+
font-size: 16px;
137152
line-height: 1.65;
138153
color: var(--vp-c-text-2);
139154
}
@@ -149,7 +164,9 @@
149164
/* ── Button ────────────────────────────────────────────────────────────── */
150165
.cta-btn {
151166
flex-shrink: 0;
152-
display: inline-block;
167+
display: inline-flex;
168+
align-items: center;
169+
gap: 7px;
153170
padding: 10px 22px;
154171
border-radius: 9999px;
155172
background: linear-gradient(135deg, #9933ff 0%, #7a1fd4 100%);
@@ -165,6 +182,10 @@
165182
background 0.2s;
166183
}
167184
185+
.cta-btn-arrow {
186+
flex-shrink: 0;
187+
}
188+
168189
.cta-btn:hover {
169190
background: linear-gradient(135deg, #aa44ff 0%, #9933ff 100%);
170191
box-shadow: 0 6px 28px rgba(153, 51, 255, 0.5);

‎docs/.vitepress/theme/RichFooter.vue‎

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,24 @@
108108
>
109109
</li>
110110
<li>
111-
<a href="https://fulll.fr" target="_blank" rel="noopener noreferrer"> fulll.fr ↗ </a>
111+
<a href="https://fulll.fr" target="_blank" rel="noopener noreferrer">
112+
fulll.fr
113+
<svg
114+
class="rf-ext-arrow"
115+
aria-hidden="true"
116+
xmlns="http://www.w3.org/2000/svg"
117+
width="11"
118+
height="11"
119+
viewBox="0 0 24 24"
120+
fill="none"
121+
stroke="currentColor"
122+
stroke-width="2.2"
123+
stroke-linecap="round"
124+
stroke-linejoin="round"
125+
>
126+
<path d="M7 17L17 7M7 7h10v10" />
127+
</svg>
128+
</a>
112129
</li>
113130
</ul>
114131
</div>
@@ -228,6 +245,11 @@ const year = new Date().getFullYear();
228245
opacity: 0.7;
229246
}
230247
248+
.rf-ext-arrow {
249+
flex-shrink: 0;
250+
opacity: 0.6;
251+
}
252+
231253
/* ── Responsive ────────────────────────────────────────────────────────── */
232254
@media (max-width: 840px) {
233255
.rf-inner {

‎docs/.vitepress/theme/TestimonialsSection.vue‎

Lines changed: 39 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,22 @@
4444
target="_blank"
4545
rel="noopener noreferrer"
4646
>
47-
Share your story →
47+
<span>Share your story</span>
48+
<svg
49+
class="ts-cta-arrow"
50+
aria-hidden="true"
51+
xmlns="http://www.w3.org/2000/svg"
52+
width="12"
53+
height="12"
54+
viewBox="0 0 24 24"
55+
fill="none"
56+
stroke="currentColor"
57+
stroke-width="2.2"
58+
stroke-linecap="round"
59+
stroke-linejoin="round"
60+
>
61+
<path d="M7 17L17 7M7 7h10v10" />
62+
</svg>
4863
</a>
4964
</div>
5065
</div>
@@ -132,12 +147,19 @@ const testimonials = [
132147
gap: 20px;
133148
transition:
134149
transform 0.18s,
135-
box-shadow 0.18s;
150+
box-shadow 0.18s,
151+
border-color 0.18s;
136152
}
137153
138154
.ts-card:hover {
139155
transform: translateY(-2px);
140-
box-shadow: 0 6px 24px rgba(153, 51, 255, 0.1);
156+
box-shadow: 0 6px 24px rgba(153, 51, 255, 0.14);
157+
border-color: rgba(153, 51, 255, 0.32);
158+
}
159+
160+
.dark .ts-card:hover {
161+
border-color: rgba(204, 136, 255, 0.3);
162+
box-shadow: 0 6px 28px rgba(153, 51, 255, 0.2);
141163
}
142164
143165
/* ── Quote ─────────────────────────────────────────────────────────────── */
@@ -226,19 +248,29 @@ const testimonials = [
226248
}
227249
228250
.ts-cta-btn {
229-
display: inline-block;
251+
display: inline-flex;
252+
align-items: center;
253+
gap: 6px;
230254
padding: 8px 18px;
231255
border-radius: 8px;
232256
background: var(--vp-c-brand-1);
233-
color: #fff;
257+
color: #fff !important;
234258
font-size: 13px;
235259
font-weight: 600;
236-
text-decoration: none;
237-
transition: background 0.15s;
260+
text-decoration: none !important;
261+
transition:
262+
background 0.15s,
263+
box-shadow 0.15s;
238264
}
239265
240266
.ts-cta-btn:hover {
241267
background: #7a1fd4;
268+
color: #fff !important;
269+
box-shadow: 0 4px 16px rgba(153, 51, 255, 0.35);
270+
}
271+
272+
.ts-cta-arrow {
273+
flex-shrink: 0;
242274
}
243275
244276
/* ── Responsive ────────────────────────────────────────────────────────── */

0 commit comments

Comments
 (0)