Spaces:

HipFil98
/

PhDScout

Sleeping

HipFil98 Claude Sonnet 4.6 commited on Mar 20

Commit

e7eb232

1 Parent(s): cd1a9b6

feat: dark mode docs + add credits and citation to README

docs/index.html:
- Switch all CSS variables to macOS dark palette (black bg, dark surfaces,
blue accent #2997ff, dark callouts/tags/code backgrounds)
- Fix hardcoded light colours (inline styles, scrollbar, hover, callouts)

README.md:
- Add Credits section (Euraxess, mlscientist, jobs.ac.uk, Groq)
- Add Cite this work section with BibTeX entry

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Files changed (2) hide show

README.md +27 -0
docs/index.html +28 -28

README.md CHANGED Viewed

@@ -110,6 +110,33 @@ For local use, the app also supports **Ollama** — set `LLM_BACKEND=ollama` in
 ---
 ## License
 MIT

 ---
+## Credits
+Job data sourced from:
+- [Euraxess](https://euraxess.ec.europa.eu) — European Commission portal for research careers
+- [mlscientist.com](https://mlscientist.com) — ML & AI academic job board
+- [jobs.ac.uk](https://www.jobs.ac.uk) — UK academic jobs portal
+LLM inference powered by [Groq](https://groq.com) free API.
+---
+## Cite this work
+If you use PhdScout in your research or project, please cite it as:
+```bibtex
+@software{pellegrino2026phdscout,
+  author  = {Pellegrino, Filippo},
+  title   = {{PhdScout}: an AI-powered search agent for academic positions},
+  year    = {2026},
+  url     = {https://github.com/Hipsterfil998/PhDScout},
+  license = {MIT}
+}
+```
+---
 ## License
 MIT

docs/index.html CHANGED Viewed

@@ -6,22 +6,22 @@
 <title>PhdScout — Documentation</title>
 <style>
   :root {
-    --bg: #f5f5f7;
-    --surface: #ffffff;
-    --sidebar-bg: rgba(255,255,255,0.72);
-    --border: rgba(0,0,0,0.08);
-    --text: #1d1d1f;
-    --text-secondary: #6e6e73;
-    --accent: #0071e3;
-    --accent-hover: #0077ed;
-    --code-bg: #1c1c1e;
     --code-text: #e8e8ed;
-    --tag-bg: #e8f0fe;
-    --tag-text: #1a73e8;
     --radius: 12px;
     --radius-sm: 8px;
-    --shadow: 0 2px 20px rgba(0,0,0,0.08);
-    --shadow-lg: 0 8px 40px rgba(0,0,0,0.12);
     --sidebar-w: 240px;
     --font: -apple-system, BlinkMacSystemFont, "SF Pro Text", "Helvetica Neue", Arial, sans-serif;
     --font-mono: "SF Mono", "Fira Code", "Cascadia Code", Menlo, monospace;
@@ -238,10 +238,10 @@
   code {
     font-family: var(--font-mono);
     font-size: 13px;
-    background: rgba(0,0,0,0.06);
     padding: 2px 6px;
     border-radius: 4px;
-    color: #c0392b;
   }
   pre code {
@@ -312,7 +312,7 @@
   }
   tr:last-child td { border-bottom: none; }
-  tr:hover td { background: rgba(0,0,0,0.02); }
   /* ── Callout ─────────────────────────────────────────── */
   .callout {
@@ -324,9 +324,9 @@
   }
   .callout-icon { font-size: 18px; flex-shrink: 0; margin-top: 1px; }
-  .callout.info { background: #e8f0fe; border-left: 3px solid #1a73e8; }
-  .callout.warn { background: #fef9e0; border-left: 3px solid #f5a623; }
-  .callout.tip  { background: #e6f4ea; border-left: 3px solid #34a853; }
   .callout p { margin: 0; }
   /* ── Tag ─────────────────────────────────────────────── */
@@ -372,7 +372,7 @@
   /* ── Scrollbar ───────────────────────────────────────── */
   ::-webkit-scrollbar { width: 6px; }
   ::-webkit-scrollbar-track { background: transparent; }
-  ::-webkit-scrollbar-thumb { background: rgba(0,0,0,0.2); border-radius: 3px; }
 </style>
 </head>
 <body>
@@ -877,21 +877,21 @@ The letter should be <span class="st">250-350 words (2-3 paragraphs)</span>.</co
     <h2>Pipeline flow</h2>
     <div class="card">
-      <p style="font-family:var(--font-mono);font-size:13px;line-height:2;color:#1d1d1f;">
         CV file<br>
-        &nbsp;&nbsp;↓ <span style="color:#6e6e73">CVParser.extract_raw_text()</span><br>
         Raw text<br>
-        &nbsp;&nbsp;↓ <span style="color:#6e6e73">CVParser.parse() → LLM → CVProfile JSON</span><br>
-        &nbsp;&nbsp;↓ <span style="color:#6e6e73">CVParser.summarize() → profile_text</span><br>
         profile_text<br>
         &nbsp;&nbsp;↓ (in parallel with search)<br>
-        &nbsp;&nbsp;↓ <span style="color:#6e6e73">JobSearcher.search() → scrapers → deduplicate → filter stale → label freshness</span><br>
         jobs[]<br>
-        &nbsp;&nbsp;↓ <span style="color:#6e6e73">JobMatcher.score_all() → LLM × N → sort by score</span><br>
         scored_jobs[]<br>
         &nbsp;&nbsp;↓ (per selected job)<br>
-        &nbsp;&nbsp;↓ <span style="color:#6e6e73">CVTailor.generate() → LLM → TailoringHints</span><br>
-        &nbsp;&nbsp;↓ <span style="color:#6e6e73">CoverLetterWriter.generate() → LLM → draft letter</span><br>
         approved_jobs[] → ZIP export
       </p>
     </div>

 <title>PhdScout — Documentation</title>
 <style>
   :root {
+    --bg: #000000;
+    --surface: #1c1c1e;
+    --sidebar-bg: rgba(28,28,30,0.88);
+    --border: rgba(255,255,255,0.10);
+    --text: #f5f5f7;
+    --text-secondary: #98989d;
+    --accent: #2997ff;
+    --accent-hover: #47aaff;
+    --code-bg: #111113;
     --code-text: #e8e8ed;
+    --tag-bg: #0a2540;
+    --tag-text: #4da6ff;
     --radius: 12px;
     --radius-sm: 8px;
+    --shadow: 0 2px 20px rgba(0,0,0,0.40);
+    --shadow-lg: 0 8px 40px rgba(0,0,0,0.60);
     --sidebar-w: 240px;
     --font: -apple-system, BlinkMacSystemFont, "SF Pro Text", "Helvetica Neue", Arial, sans-serif;
     --font-mono: "SF Mono", "Fira Code", "Cascadia Code", Menlo, monospace;
   code {
     font-family: var(--font-mono);
     font-size: 13px;
+    background: rgba(255,255,255,0.08);
     padding: 2px 6px;
     border-radius: 4px;
+    color: #ff6b6b;
   }
   pre code {
   }
   tr:last-child td { border-bottom: none; }
+  tr:hover td { background: rgba(255,255,255,0.04); }
   /* ── Callout ─────────────────────────────────────────── */
   .callout {
   }
   .callout-icon { font-size: 18px; flex-shrink: 0; margin-top: 1px; }
+  .callout.info { background: #0a1f3a; border-left: 3px solid #2997ff; }
+  .callout.warn { background: #2a1f00; border-left: 3px solid #f5a623; }
+  .callout.tip  { background: #0a2018; border-left: 3px solid #30d158; }
   .callout p { margin: 0; }
   /* ── Tag ─────────────────────────────────────────────── */
   /* ── Scrollbar ───────────────────────────────────────── */
   ::-webkit-scrollbar { width: 6px; }
   ::-webkit-scrollbar-track { background: transparent; }
+  ::-webkit-scrollbar-thumb { background: rgba(255,255,255,0.2); border-radius: 3px; }
 </style>
 </head>
 <body>
     <h2>Pipeline flow</h2>
     <div class="card">
+      <p style="font-family:var(--font-mono);font-size:13px;line-height:2;color:var(--text);">
         CV file<br>
+        &nbsp;&nbsp;↓ <span style="color:#98989d">CVParser.extract_raw_text()</span><br>
         Raw text<br>
+        &nbsp;&nbsp;↓ <span style="color:#98989d">CVParser.parse() → LLM → CVProfile JSON</span><br>
+        &nbsp;&nbsp;↓ <span style="color:#98989d">CVParser.summarize() → profile_text</span><br>
         profile_text<br>
         &nbsp;&nbsp;↓ (in parallel with search)<br>
+        &nbsp;&nbsp;↓ <span style="color:#98989d">JobSearcher.search() → scrapers → deduplicate → filter stale → label freshness</span><br>
         jobs[]<br>
+        &nbsp;&nbsp;↓ <span style="color:#98989d">JobMatcher.score_all() → LLM × N → sort by score</span><br>
         scored_jobs[]<br>
         &nbsp;&nbsp;↓ (per selected job)<br>
+        &nbsp;&nbsp;↓ <span style="color:#98989d">CVTailor.generate() → LLM → TailoringHints</span><br>
+        &nbsp;&nbsp;↓ <span style="color:#98989d">CoverLetterWriter.generate() → LLM → draft letter</span><br>
         approved_jobs[] → ZIP export
       </p>
     </div>