From 8aa67db83e81eeef0b96a5bd0c46f4cc3ada7897 Mon Sep 17 00:00:00 2001 From: dingdingcar <1054263492@qq.com> Date: Sun, 8 Nov 2026 10:18:06 -0800 Subject: [PATCH] docs: changelog for v3.0.0 and bump the version to 3.0.0 The Unreleased section listed only the plugin marketplace, organize-wiki, and domain routing. It now records every user-visible change since v2.3.1 as v3.0.0: reading by paper type, Takeaways, user-owned My Notes, Connections, structured frontmatter, research-memory, Visual Review, the required final quality review, label-named vault images, and the extraction, title, and Windows fixes. Upgrade notes cover old notes and the removed domain_rules.yaml, which is why this is a major version. The version moves to 3.0.0 in both plugin manifests and pyproject.toml, so `claude plugin update` sees the new release. Co-Authored-By: Claude Opus 5.5 --- .claude-plugin/plugin.json | 2 +- .codex-plugin/plugin.json | 2 +- CHANGELOG.md | 42 ++++++++++++++++++++++++++++++++++++-- pyproject.toml | 2 +- 4 files changed, 43 insertions(+), 5 deletions(-) diff --git a/.claude-plugin/plugin.json b/.claude-plugin/plugin.json index 6667344d..478c13db 100644 --- a/.claude-plugin/plugin.json +++ b/.claude-plugin/plugin.json @@ -1,7 +1,7 @@ { "name": "deeppapernote", "description": "Academic paper reading and Obsidian note generation skills for building a research WIKI.", - "version": "2.3.1", + "version": "3.0.0", "author": { "name": "917Dhj" }, diff --git a/.codex-plugin/plugin.json b/.codex-plugin/plugin.json index 13b85141..8f6dc08c 100644 --- a/.codex-plugin/plugin.json +++ b/.codex-plugin/plugin.json @@ -1,6 +1,6 @@ { "name": "deeppapernote", - "version": "2.3.1", + "version": "3.0.0", "description": "Academic paper reading and Obsidian note generation skills for building a research WIKI.", "author": { "name": "917Dhj", diff --git a/CHANGELOG.md b/CHANGELOG.md index dccb8592..e39ccc6d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,16 +12,54 @@ Add an entry here when the project meaningfully changes for users, for example: ## Unreleased -### Added +## v3.0.0 -- DeepPaperNote can now be installed as a Claude Code plugin from the repository's own marketplace, with `claude plugin marketplace add 917Dhj/DeepPaperNote`. The skills CLI (`npx skills add`) remains the agent-neutral route. +DeepPaperNote now reads each paper by its type, and every note joins your vault. + +### Added +- **Reading by paper type.** Each paper is read as one of ten types: method, system, theory, position, benchmark or dataset, discovery empirical, human-subjects empirical, survey or review, qualitative empirical, and humanities argument. The type decides the note's middle sections, the core questions it must answer, and its workflow table. The questions draw on reviewer guidelines and reporting standards such as those of NeurIPS, ICLR, ACL, CONSORT, and PRISMA. +- **Takeaways** follows Limitations, with Transferable Ideas and Next Steps. +- **My Notes** now belongs to you: a new note holds only a guidance line, and regenerating the note keeps whatever you wrote there. +- **Connections** replaces References. It links the note to related paper notes already in your vault, whether the paper cites them or not, and lists the key prior work instead of copying the bibliography. +- **Structured frontmatter** on every note (`paper_type`, `methods`, `datasets`, `tasks`, `read_date`, and more). The keys stay in English in both languages, so one Obsidian Bases view can query every note. +- `research-memory` is a new companion skill that keeps a note of your research directions. DeepPaperNote reads it to tailor each note's Takeaways to your research. - `organize-wiki` is a new companion skill that organizes the paper library with you. It agrees on the domain folders and writes them as `/DeepPaperNote/domains.md`. After you confirm a preview, it moves misfiled paper folders, fixes `papers/` tags, and rewrites path links. Every reorganization is logged and the last one can be undone. +- DeepPaperNote can now be installed as a Claude Code plugin from the repository's own marketplace, with `claude plugin marketplace add 917Dhj/DeepPaperNote`. The skills CLI (`npx skills add`) remains the agent-neutral route. +- **Visual Review.** Every figure and table candidate is reviewed visually before it enters the note, and one that does not hold up is left out with a recorded reason. +- `run_state.py status` reports a run's progress, missing artifacts, and next step, without changing anything. ### Changed +- Notes are written as one story for a reader from an adjacent field, and the final review checks that story along with the answers to the core questions. +- The final quality review is now a required gate: Formal Save refuses a note that has not passed it. - The agent now chooses each new paper's domain folder after reading what the existing domains hold, or the user's convention in `/DeepPaperNote/domains.md`. It reuses an existing domain by default and creates a new one only with a stated reason, which the final report repeats. The keyword table `domain_rules.yaml` is removed. - A saved note carries exactly one `papers/` tag, and it must name the folder the note is saved in. +- Images saved in the vault are named after their label in the paper, such as `Figure_1.png`. +- When a glossary library shares the vault, DeepPaperNote suggests running `paper-glossary` on the paper after saving. +- Regenerating a note replaces a re-cropped image of the same name instead of refusing the save. + +### Fixed + +- Figure and table extraction, now checked against a 34-paper regression corpus: captions are read from the page layout; crops stay in their column and keep every table row; bilingual table captions and figures printed under their caption crop correctly; footnote marks no longer end up in captions. +- Title detection no longer mistakes a journal header or a split subtitle for the title, and keeps lead-ins such as `Position:`. +- A PDF whose text cannot be read now stops the run instead of producing a note. +- Script output no longer fails on Windows consoles with encodings such as cp1252. +- `paper-glossary` now links terms written in backticks. +- The Chinese style check no longer counts formulas and backticked names. + +### Upgrade notes + +- Notes saved by earlier versions keep their old structure until you regenerate them. When a regenerated note keeps an old 我的笔记 section, the save report says it may hold text the model wrote, so you can check it. +- `domain_rules.yaml` is removed. To shape how papers are filed, use `organize-wiki`, which writes `/DeepPaperNote/domains.md`. + +### Internal + +- The pipeline runs in separate acquire and prepare phases, `common.py` is split by responsibility, and CI runs ruff and the parallel test suite on Linux, macOS, and Windows. + +### Documentation + +- Rewrote both READMEs around what users get from DeepPaperNote. ## v2.3.1 diff --git a/pyproject.toml b/pyproject.toml index bb4ed7c2..cd8b6c87 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta" [project] name = "deeppapernote" -version = "2.3.1" +version = "3.0.0" description = "An agent-neutral skill for turning one research paper into a high-quality Obsidian note." readme = "README.md" requires-python = ">=3.10"