Merge pull request #3 from HuaDongJian/docs-api-frontend-polish-v2

Update docs and polish downstream frontend outputs

Author: GoooDte

.github/workflows/pages.yml

@@ -0,0 +1,42 @@
+name: Deploy API Docs
+
+on:
+  push:
+    branches:
+      - main
+      - package/scinet-client-cli
+    paths:
+      - docs/**
+      - .github/workflows/pages.yml
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Configure Pages
+        uses: actions/configure-pages@v5
+
+      - name: Upload docs
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

README.md

@@ -7,7 +7,11 @@
 </p>
 
 <p align="center">
+<<<<<<< HEAD
   <a href="docs/api/SCINET_API_DOC.html">📚 API Docs Website</a>
+=======
+  <a href="https://huadongjian.github.io/SciNet/api/SCINET_API_DOC.html">📚 API Docs Website</a>
+>>>>>>> 3d1a104 (Update docs and polish downstream frontend outputs)
 </p>
 
 <p align="center">
@@ -71,6 +75,7 @@ With the client, you can:
 ## 📑 Table of Contents
 
 - [✨ Overview](#-overview)
+<<<<<<< HEAD
 - [🚀 Quick Start](#-quick-start)
 - [🔑 API Token](#-api-token)
 - [🧠 What SciNet Does](#-what-scinet-does)
@@ -86,6 +91,46 @@ With the client, you can:
 - [🧯 Troubleshooting](#-troubleshooting)
 - [🗺️ Roadmap](#-roadmap)
 - [✍️ Citation](#-citation)
+=======
+- [� Table of Contents](#-table-of-contents)
+- [🚀 Quick Start](#-quick-start)
+  - [1. Install](#1-install)
+  - [2. Register an API Token](#2-register-an-api-token)
+  - [3. Configure](#3-configure)
+  - [4. Test](#4-test)
+  - [5. Run a Paper Search](#5-run-a-paper-search)
+- [🔑 API Token](#-api-token)
+  - [Browser Registration](#browser-registration)
+  - [Check Token Status](#check-token-status)
+  - [Check Usage](#check-usage)
+- [🧠 What SciNet Does](#-what-scinet-does)
+- [🧩 Supported Tasks](#-supported-tasks)
+- [🛠️ CLI-First Workflow](#️-cli-first-workflow)
+  - [Help](#help)
+  - [Basic Retrieval](#basic-retrieval)
+  - [Retrieval Modes](#retrieval-modes)
+  - [Expert Anchors](#expert-anchors)
+  - [Graph Bias Parameters](#graph-bias-parameters)
+- [🧰 Editable Skills](#-editable-skills)
+- [🐍 Python SDK](#-python-sdk)
+- [⚙️ Configuration](#️-configuration)
+- [🧪 Examples](#-examples)
+  - [Literature Review](#literature-review)
+  - [Idea Evaluation](#idea-evaluation)
+  - [Idea Generation](#idea-generation)
+  - [Trend Report](#trend-report)
+  - [Researcher Review](#researcher-review)
+- [📦 Outputs and Artifacts](#-outputs-and-artifacts)
+- [🛠️ GROBID for PDF Workflows](#️-grobid-for-pdf-workflows)
+- [📂 Repository Layout](#-repository-layout)
+- [🧯 Troubleshooting](#-troubleshooting)
+  - [`scinet health` works but `search-papers` returns 401](#scinet-health-works-but-search-papers-returns-401)
+  - [No email verification code](#no-email-verification-code)
+  - [Retrieval is slow or times out](#retrieval-is-slow-or-times-out)
+  - [`scinet` command is not found on Windows](#scinet-command-is-not-found-on-windows)
+- [📝 TODO](#-todo)
+- [✍️ Citation](#️-citation)
+>>>>>>> 3d1a104 (Update docs and polish downstream frontend outputs)
 - [📄 License](#-license)
 
 ---
@@ -568,31 +613,27 @@ or reinstall:
 
 ---
 
+<<<<<<< HEAD
 ## 🗺️ Roadmap
+=======
+## 📝 TODO
+>>>>>>> 3d1a104 (Update docs and polish downstream frontend outputs)
 
-- [ ] PyPI release for `pip install scinet-client`
-- [ ] `scinet auth login/status/usage`
-- [ ] More built-in skills for agent workflows
-- [ ] Token reset and revoke support
-- [ ] API playground
-- [ ] MCP / agent runtime integration
-- [ ] Broader knowledge types beyond papers, such as datasets, code, standards, theorems, and experimental experience
-- [ ] Dedicated benchmarks for scientific research tasks
-- [ ] More systematic dynamic knowledge updates
+- [ ] **CLI Tools.** Add more user-facing CLI capabilities so downstream users and AI agents can invoke retrieval workflows without touching database internals.
+- [ ] **Skills.** Package reusable agent skills for common scientific discovery workflows and expose best practices as easier-to-load components.
+- [ ] **More Knowledge.** Integrate more knowledge forms beyond paper-centric entities, such as datasets, code, standards, theorems, and experimental experience.
+- [ ] **Benchmark and Evaluation.** Build dedicated benchmarks and evaluation protocols for downstream scientific research tasks supported by SciNet.
+- [ ] **Dynamic Update**Improve dynamic knowledge updates toward a more systematic and frequent refresh mechanism.
+- [ ] **Dynamic Update.** Improve dynamic knowledge updates toward a more systematic and frequent refresh mechanism.
 
 ---
 
 ## ✍️ Citation
 
 If you find SciNet helpful, please cite:
 
-```bibtex
-@article{scinet2026,
-  title={SciNet: A Large-Scale Knowledge Graph for Automated Scientific Research},
-  author={SciNet Team},
-  journal={arXiv preprint arXiv:2602.14367},
-  year={2026}
-}
+```
+
 ```
 
 ---

README_zh.md

@@ -7,7 +7,11 @@
 </p>
 
 <p align="center">
+<<<<<<< HEAD
   <a href="docs/api/SCINET_API_DOC_zh.html">📚 API 文档站</a>
+=======
+  <a href="https://huadongjian.github.io/SciNet/api/SCINET_API_DOC_zh.html">📚 API 文档站</a>
+>>>>>>> 3d1a104 (Update docs and polish downstream frontend outputs)
 </p>
 
 <p align="center">
@@ -60,6 +64,7 @@
 ## 📑 目录
 
 - [✨ 项目概览](#-项目概览)
+<<<<<<< HEAD
 - [🚀 快速开始](#-快速开始)
 - [🔑 API Token](#-api-token)
 - [🧠 SciNet 能做什么](#-scinet-能做什么)
@@ -75,6 +80,42 @@
 - [🧯 常见问题](#-常见问题)
 - [🗺️ Roadmap](#-roadmap)
 - [✍️ Citation](#-citation)
+=======
+- [� 目录](#-目录)
+- [🚀 快速开始](#-快速开始)
+  - [1. 安装](#1-安装)
+  - [2. 注册 API Token](#2-注册-api-token)
+  - [3. 配置](#3-配置)
+  - [4. 测试](#4-测试)
+  - [5. 运行论文检索](#5-运行论文检索)
+- [🔑 API Token](#-api-token)
+  - [浏览器注册](#浏览器注册)
+  - [查询 Token 状态](#查询-token-状态)
+  - [查询用量](#查询用量)
+- [🧠 SciNet 能做什么](#-scinet-能做什么)
+- [🧩 支持任务](#-支持任务)
+- [🛠️ CLI 优先工作流](#️-cli-优先工作流)
+  - [检索模式](#检索模式)
+  - [专家锚点](#专家锚点)
+  - [图检索偏好](#图检索偏好)
+- [🧰 可编辑 Skills](#-可编辑-skills)
+- [🐍 Python SDK](#-python-sdk)
+- [⚙️ 配置说明](#️-配置说明)
+- [🧪 示例命令](#-示例命令)
+  - [文献综述](#文献综述)
+  - [Idea Evaluation](#idea-evaluation)
+  - [Trend Report](#trend-report)
+- [📦 输出与运行产物](#-输出与运行产物)
+- [🛠️ PDF 工作流中的 GROBID](#️-pdf-工作流中的-grobid)
+- [📂 仓库结构](#-仓库结构)
+- [🧯 常见问题](#-常见问题)
+  - [`scinet health` 成功，但 `search-papers` 返回 401](#scinet-health-成功但-search-papers-返回-401)
+  - [没有收到邮箱验证码](#没有收到邮箱验证码)
+  - [检索很慢或超时](#检索很慢或超时)
+  - [Windows 上找不到 `scinet` 命令](#windows-上找不到-scinet-命令)
+- [📝 TODO](#-todo)
+- [✍️ Citation](#️-citation)
+>>>>>>> 3d1a104 (Update docs and polish downstream frontend outputs)
 - [📄 License](#-license)
 
 ---
@@ -481,6 +522,7 @@ set SCINET_API_KEY=your-personal-scinet-token
 
 ---
 
+<<<<<<< HEAD
 ## 🗺️ Roadmap
 
 - [ ] 发布 PyPI 包，支持 `pip install scinet-client`
@@ -505,6 +547,24 @@ set SCINET_API_KEY=your-personal-scinet-token
   journal={arXiv preprint arXiv:2602.14367},
   year={2026}
 }
+=======
+## 📝 TODO
+
+- [ ] **命令行工具。** 增加更多面向用户的命令行功能，以便下游用户和 AI 代理无需接触数据库内部即可调用检索工作流。
+- [ ] **技能。** 为常见的科学发现工作流打包可重用的代理技能，并将最佳实践作为更易于加载的组件提供。
+- [ ] **更多知识。** 整合超越以论文为中心的实体之外的更多知识形式，例如数据集、代码、标准、定理和实验经验。
+- [ ] **基准测试与评估。** 为 SciNet 支持的下游科学研究任务构建专用基准测试和评估协议。
+- [ ] **动态更新** 改进动态知识更新机制，使其更加系统化并提高刷新频率。
+- [ ] **动态更新。** 改进动态知识更新机制，使其更加系统化并提高刷新频率。
+
+---
+
+## ✍️ Citation
+
+如果 SciNet 对你的研究有帮助，请引用：
+```
+
+>>>>>>> 3d1a104 (Update docs and polish downstream frontend outputs)
 ```
 
 ---