Skip to content

Commit 6c227bd

Browse files
committed
Update docs and polish downstream frontend outputs
1 parent b2ca9d5 commit 6c227bd

3 files changed

Lines changed: 159 additions & 16 deletions

File tree

.github/workflows/pages.yml

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Deploy API Docs
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
- package/scinet-client-cli
8+
paths:
9+
- docs/**
10+
- .github/workflows/pages.yml
11+
workflow_dispatch:
12+
13+
permissions:
14+
contents: read
15+
pages: write
16+
id-token: write
17+
18+
concurrency:
19+
group: pages
20+
cancel-in-progress: false
21+
22+
jobs:
23+
deploy:
24+
environment:
25+
name: github-pages
26+
url: ${{ steps.deployment.outputs.page_url }}
27+
runs-on: ubuntu-latest
28+
steps:
29+
- name: Checkout
30+
uses: actions/checkout@v4
31+
32+
- name: Configure Pages
33+
uses: actions/configure-pages@v5
34+
35+
- name: Upload docs
36+
uses: actions/upload-pages-artifact@v3
37+
with:
38+
path: docs
39+
40+
- name: Deploy to GitHub Pages
41+
id: deployment
42+
uses: actions/deploy-pages@v4

README.md

Lines changed: 57 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,11 @@
77
</p>
88

99
<p align="center">
10+
<<<<<<< HEAD
1011
<a href="docs/api/SCINET_API_DOC.html">📚 API Docs Website</a>
12+
=======
13+
<a href="https://huadongjian.github.io/SciNet/api/SCINET_API_DOC.html">📚 API Docs Website</a>
14+
>>>>>>> 3d1a104 (Update docs and polish downstream frontend outputs)
1115
</p>
1216
1317
<p align="center">
@@ -71,6 +75,7 @@ With the client, you can:
7175
## 📑 Table of Contents
7276

7377
- [✨ Overview](#-overview)
78+
<<<<<<< HEAD
7479
- [🚀 Quick Start](#-quick-start)
7580
- [🔑 API Token](#-api-token)
7681
- [🧠 What SciNet Does](#-what-scinet-does)
@@ -86,6 +91,46 @@ With the client, you can:
8691
- [🧯 Troubleshooting](#-troubleshooting)
8792
- [🗺️ Roadmap](#-roadmap)
8893
- [✍️ Citation](#-citation)
94+
=======
95+
- [� Table of Contents](#-table-of-contents)
96+
- [🚀 Quick Start](#-quick-start)
97+
- [1. Install](#1-install)
98+
- [2. Register an API Token](#2-register-an-api-token)
99+
- [3. Configure](#3-configure)
100+
- [4. Test](#4-test)
101+
- [5. Run a Paper Search](#5-run-a-paper-search)
102+
- [🔑 API Token](#-api-token)
103+
- [Browser Registration](#browser-registration)
104+
- [Check Token Status](#check-token-status)
105+
- [Check Usage](#check-usage)
106+
- [🧠 What SciNet Does](#-what-scinet-does)
107+
- [🧩 Supported Tasks](#-supported-tasks)
108+
- [🛠️ CLI-First Workflow](#️-cli-first-workflow)
109+
- [Help](#help)
110+
- [Basic Retrieval](#basic-retrieval)
111+
- [Retrieval Modes](#retrieval-modes)
112+
- [Expert Anchors](#expert-anchors)
113+
- [Graph Bias Parameters](#graph-bias-parameters)
114+
- [🧰 Editable Skills](#-editable-skills)
115+
- [🐍 Python SDK](#-python-sdk)
116+
- [⚙️ Configuration](#️-configuration)
117+
- [🧪 Examples](#-examples)
118+
- [Literature Review](#literature-review)
119+
- [Idea Evaluation](#idea-evaluation)
120+
- [Idea Generation](#idea-generation)
121+
- [Trend Report](#trend-report)
122+
- [Researcher Review](#researcher-review)
123+
- [📦 Outputs and Artifacts](#-outputs-and-artifacts)
124+
- [🛠️ GROBID for PDF Workflows](#️-grobid-for-pdf-workflows)
125+
- [📂 Repository Layout](#-repository-layout)
126+
- [🧯 Troubleshooting](#-troubleshooting)
127+
- [`scinet health` works but `search-papers` returns 401](#scinet-health-works-but-search-papers-returns-401)
128+
- [No email verification code](#no-email-verification-code)
129+
- [Retrieval is slow or times out](#retrieval-is-slow-or-times-out)
130+
- [`scinet` command is not found on Windows](#scinet-command-is-not-found-on-windows)
131+
- [📝 TODO](#-todo)
132+
- [✍️ Citation](#️-citation)
133+
>>>>>>> 3d1a104 (Update docs and polish downstream frontend outputs)
89134
- [📄 License](#-license)
90135

91136
---
@@ -568,31 +613,27 @@ or reinstall:
568613

569614
---
570615

616+
<<<<<<< HEAD
571617
## 🗺️ Roadmap
618+
=======
619+
## 📝 TODO
620+
>>>>>>> 3d1a104 (Update docs and polish downstream frontend outputs)
572621
573-
- [ ] PyPI release for `pip install scinet-client`
574-
- [ ] `scinet auth login/status/usage`
575-
- [ ] More built-in skills for agent workflows
576-
- [ ] Token reset and revoke support
577-
- [ ] API playground
578-
- [ ] MCP / agent runtime integration
579-
- [ ] Broader knowledge types beyond papers, such as datasets, code, standards, theorems, and experimental experience
580-
- [ ] Dedicated benchmarks for scientific research tasks
581-
- [ ] More systematic dynamic knowledge updates
622+
- [ ] **CLI Tools.** Add more user-facing CLI capabilities so downstream users and AI agents can invoke retrieval workflows without touching database internals.
623+
- [ ] **Skills.** Package reusable agent skills for common scientific discovery workflows and expose best practices as easier-to-load components.
624+
- [ ] **More Knowledge.** Integrate more knowledge forms beyond paper-centric entities, such as datasets, code, standards, theorems, and experimental experience.
625+
- [ ] **Benchmark and Evaluation.** Build dedicated benchmarks and evaluation protocols for downstream scientific research tasks supported by SciNet.
626+
- [ ] **Dynamic Update**Improve dynamic knowledge updates toward a more systematic and frequent refresh mechanism.
627+
- [ ] **Dynamic Update.** Improve dynamic knowledge updates toward a more systematic and frequent refresh mechanism.
582628

583629
---
584630

585631
## ✍️ Citation
586632

587633
If you find SciNet helpful, please cite:
588634

589-
```bibtex
590-
@article{scinet2026,
591-
title={SciNet: A Large-Scale Knowledge Graph for Automated Scientific Research},
592-
author={SciNet Team},
593-
journal={arXiv preprint arXiv:2602.14367},
594-
year={2026}
595-
}
635+
```
636+
596637
```
597638

598639
---

README_zh.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,11 @@
77
</p>
88

99
<p align="center">
10+
<<<<<<< HEAD
1011
<a href="docs/api/SCINET_API_DOC_zh.html">📚 API 文档站</a>
12+
=======
13+
<a href="https://huadongjian.github.io/SciNet/api/SCINET_API_DOC_zh.html">📚 API 文档站</a>
14+
>>>>>>> 3d1a104 (Update docs and polish downstream frontend outputs)
1115
</p>
1216
1317
<p align="center">
@@ -60,6 +64,7 @@
6064
## 📑 目录
6165

6266
- [✨ 项目概览](#-项目概览)
67+
<<<<<<< HEAD
6368
- [🚀 快速开始](#-快速开始)
6469
- [🔑 API Token](#-api-token)
6570
- [🧠 SciNet 能做什么](#-scinet-能做什么)
@@ -75,6 +80,42 @@
7580
- [🧯 常见问题](#-常见问题)
7681
- [🗺️ Roadmap](#-roadmap)
7782
- [✍️ Citation](#-citation)
83+
=======
84+
- [� 目录](#-目录)
85+
- [🚀 快速开始](#-快速开始)
86+
- [1. 安装](#1-安装)
87+
- [2. 注册 API Token](#2-注册-api-token)
88+
- [3. 配置](#3-配置)
89+
- [4. 测试](#4-测试)
90+
- [5. 运行论文检索](#5-运行论文检索)
91+
- [🔑 API Token](#-api-token)
92+
- [浏览器注册](#浏览器注册)
93+
- [查询 Token 状态](#查询-token-状态)
94+
- [查询用量](#查询用量)
95+
- [🧠 SciNet 能做什么](#-scinet-能做什么)
96+
- [🧩 支持任务](#-支持任务)
97+
- [🛠️ CLI 优先工作流](#️-cli-优先工作流)
98+
- [检索模式](#检索模式)
99+
- [专家锚点](#专家锚点)
100+
- [图检索偏好](#图检索偏好)
101+
- [🧰 可编辑 Skills](#-可编辑-skills)
102+
- [🐍 Python SDK](#-python-sdk)
103+
- [⚙️ 配置说明](#️-配置说明)
104+
- [🧪 示例命令](#-示例命令)
105+
- [文献综述](#文献综述)
106+
- [Idea Evaluation](#idea-evaluation)
107+
- [Trend Report](#trend-report)
108+
- [📦 输出与运行产物](#-输出与运行产物)
109+
- [🛠️ PDF 工作流中的 GROBID](#️-pdf-工作流中的-grobid)
110+
- [📂 仓库结构](#-仓库结构)
111+
- [🧯 常见问题](#-常见问题)
112+
- [`scinet health` 成功,但 `search-papers` 返回 401](#scinet-health-成功但-search-papers-返回-401)
113+
- [没有收到邮箱验证码](#没有收到邮箱验证码)
114+
- [检索很慢或超时](#检索很慢或超时)
115+
- [Windows 上找不到 `scinet` 命令](#windows-上找不到-scinet-命令)
116+
- [📝 TODO](#-todo)
117+
- [✍️ Citation](#️-citation)
118+
>>>>>>> 3d1a104 (Update docs and polish downstream frontend outputs)
78119
- [📄 License](#-license)
79120

80121
---
@@ -481,6 +522,7 @@ set SCINET_API_KEY=your-personal-scinet-token
481522

482523
---
483524

525+
<<<<<<< HEAD
484526
## 🗺️ Roadmap
485527

486528
- [ ] 发布 PyPI 包,支持 `pip install scinet-client`
@@ -505,6 +547,24 @@ set SCINET_API_KEY=your-personal-scinet-token
505547
journal={arXiv preprint arXiv:2602.14367},
506548
year={2026}
507549
}
550+
=======
551+
## 📝 TODO
552+
553+
- [ ] **命令行工具。** 增加更多面向用户的命令行功能,以便下游用户和 AI 代理无需接触数据库内部即可调用检索工作流。
554+
- [ ] **技能。** 为常见的科学发现工作流打包可重用的代理技能,并将最佳实践作为更易于加载的组件提供。
555+
- [ ] **更多知识。** 整合超越以论文为中心的实体之外的更多知识形式,例如数据集、代码、标准、定理和实验经验。
556+
- [ ] **基准测试与评估。** 为 SciNet 支持的下游科学研究任务构建专用基准测试和评估协议。
557+
- [ ] **动态更新** 改进动态知识更新机制,使其更加系统化并提高刷新频率。
558+
- [ ] **动态更新。** 改进动态知识更新机制,使其更加系统化并提高刷新频率。
559+
560+
---
561+
562+
## ✍️ Citation
563+
564+
如果 SciNet 对你的研究有帮助,请引用:
565+
```
566+
567+
>>>>>>> 3d1a104 (Update docs and polish downstream frontend outputs)
508568
```
509569
510570
---

0 commit comments

Comments
 (0)