Skip to content

Commit 4b8b43a

Browse files
docs: add acronym sync usage to README and Quick Start (#1032)
* docs: document acronym sync and acronym query flow [AI-assisted] Add explicit CLI examples for syncing acronym data and querying journals by acronym so users can discover and use the new acronym workflow from README and Quick Start. * docs: use concrete acronym example and link acronym dataset [AI-assisted] Replace placeholder acronym examples with a real journal acronym for consistency with existing README/Quick Start examples, and add a direct link to the curated acronym dataset repository used by acronym sync. --------- Co-authored-by: florath-ai-assistant[bot] <Andreas.Florath@telekom.de>
1 parent 93c32b9 commit 4b8b43a

File tree

2 files changed

+22
-1
lines changed

2 files changed

+22
-1
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,12 @@ aletheia-probe status
5454
# Assess a single journal
5555
aletheia-probe journal "Journal of Computer Science"
5656
57+
# Sync acronym dataset used for acronym-based venue expansion
58+
aletheia-probe acronym sync
59+
60+
# Assess using a journal acronym after syncing the acronym dataset
61+
aletheia-probe journal "JMLR"
62+
5763
# Assess all journals in a BibTeX file (returns exit code 1 if predatory journals found)
5864
aletheia-probe bibtex references.bib
5965

docs/quick-start.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,22 @@ aletheia-probe bibtex references.bib
182182
aletheia-probe bibtex references.bib --format json
183183
```
184184

185-
### 3. Check Cache Status
185+
### 3. Assess by Acronym
186+
187+
If you want to query venues by acronym, first sync the acronym dataset, then run a normal journal query with the acronym text:
188+
The dataset synced by this command is maintained in the [`venue-acronyms-2025`](https://github.com/sustainet-guardian/venue-acronyms-2025) repository.
189+
190+
```bash
191+
# Download and import the latest curated acronym dataset
192+
aletheia-probe acronym sync
193+
194+
# Assess using a journal acronym example
195+
aletheia-probe journal "JMLR"
196+
```
197+
198+
This is useful when references contain short forms (for example, common venue abbreviations) instead of full names.
199+
200+
### 4. Check Cache Status
186201

187202
```bash
188203
# Display current cache state and backend information

0 commit comments

Comments
 (0)