You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
feat: prepare for first official release (1.0.0) [AI-assisted] (#191)
Remove beta-test references from README and move BETA-TESTING.md
to docs/feedback.md with more general content for ongoing feedback
collection. This aligns with the transition to the first stable release.
Resolves#173
Co-authored-by: florath-ai-assistant[bot] <Andreas.Florath@telekom.de>
> **🚧 Beta Release** - This tool is currently in beta testing. We welcome feedback and bug reports from early adopters. See [BETA-TESTING.md](BETA-TESTING.md) for how to help test and provide feedback.
8
-
9
7
Aletheia-Probe is a comprehensive command-line tool for evaluating the legitimacy of academic journals and conferences. By aggregating data from authoritative sources and applying advanced pattern analysis, it helps researchers, librarians, and institutions detect predatory venues and ensure the integrity of scholarly publishing.
10
8
11
9
**Setting Realistic Expectations**: If you are an honest researcher using established, well-known journals and conferences through major search engines and databases, you will likely never encounter predatory venues. This tool functions like a virus scanner for academic publishing—you should have it installed and running, but hopefully never receive any warnings. It's designed to catch the edge cases and protect against the less obvious threats that might slip through normal research workflows.
@@ -26,9 +24,9 @@ Aletheia-Probe helps answer two critical questions for researchers:
26
24
```
27
25
28
26
```bash
29
-
#Beta release - Install from PyPI or source
27
+
# Install from PyPI or source
30
28
31
-
# Option 1: Install from PyPI (recommended for beta testing)
Copy file name to clipboardExpand all lines: docs/feedback.md
+34-85Lines changed: 34 additions & 85 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,30 +1,30 @@
1
-
# Beta Testing Guide
1
+
# Providing Feedback
2
2
3
-
Thank you for participating in the beta testing of the Journal Assessment Tool! Your feedback is invaluable in helping us improve the tool before the stable 1.0 release.
3
+
Thank you for using Aletheia-Probe! Your feedback is invaluable in helping us improve the tool and ensure it meets the needs of the research community.
4
4
5
-
## Current Status: Beta v0.1.0
5
+
## Current Features
6
6
7
-
This is a **pre-release version** intended for testing and feedback. The core functionality is working and tested, but there may be edge cases, platform-specific issues, or usability concerns we haven't discovered yet.
7
+
Aletheia-Probe provides comprehensive journal and conference assessment capabilities. The core functionality is stable and well-tested, but we continuously work to improve accuracy, performance, and usability based on user feedback.
source venv/bin/activate # On Windows: venv\Scripts\activate
72
-
73
-
# 3. Install in development mode
74
-
pip install -e .
75
-
76
-
# 4. Verify installation
77
-
aletheia-probe --version
78
-
79
-
# 5. Initial data synchronization (takes 3-5 minutes)
80
-
aletheia-probe sync
81
-
```
82
-
83
-
**Note**: The first `sync` command downloads and processes data from multiple sources. This is a one-time setup, though you should periodically run `aletheia-probe sync` to update data.
84
-
85
-
## Testing Scenarios
86
-
87
-
Please try to test as many of these scenarios as possible and report any issues:
44
+
Here are typical use cases you might encounter. If you experience issues with any of these, please let us know:
88
45
89
46
### 1. Basic Single Journal Assessment
90
47
@@ -181,10 +138,10 @@ time aletheia-probe bibtex large_references.bib
181
138
## Reporting Issues
182
139
183
140
### Before Reporting
184
-
1. Check the [Troubleshooting Guide](docs/troubleshooting.md)
141
+
1. Check the [Troubleshooting Guide](troubleshooting.md)
-`documentation` - Documentation issues or improvements
225
182
-`question` - Questions about usage or behavior
226
183
-`performance` - Performance-related issues
227
-
-`beta-feedback` - General beta testing feedback
184
+
-`feedback` - General user feedback
228
185
229
186
## Expected Behavior vs. Bugs
230
187
@@ -267,19 +224,19 @@ Beyond bug reports, we welcome general feedback on:
267
224
- What's missing for your needs?
268
225
269
226
Please share feedback by:
270
-
- Creating a GitHub issue with the `beta-feedback` label
227
+
- Creating a GitHub issue with the `feedback` label
271
228
- Discussing in GitHub Discussions (if enabled)
272
229
- Emailing maintainers (check CONTRIBUTING.md for contacts)
273
230
274
-
## Testing Checklist
231
+
## Feedback Checklist
275
232
276
-
Use this checklist to guide your testing:
233
+
Use this checklist to help provide comprehensive feedback:
277
234
278
235
**Installation & Setup**
279
-
-[ ]Successfully installed from PyPI OR from source
280
-
-[ ]`aletheia-probe --version` shows correct version (0.1.0)
236
+
-[ ]Installation process was straightforward
237
+
-[ ]`aletheia-probe --version` shows expected version
281
238
-[ ] First `sync` completed without errors
282
-
-[ ]`aletheia-probe status` shows data synced
239
+
-[ ]`aletheia-probe status` shows data properly synced
283
240
284
241
**Basic Functionality**
285
242
-[ ] Assess a well-known journal with `journal` command (e.g., "Nature")
@@ -312,21 +269,13 @@ Use this checklist to guide your testing:
312
269
-[ ] Troubleshooting guide helped resolve issues
313
270
-[ ] No major gaps in documentation
314
271
315
-
## Beta Testing Timeline
316
-
317
-
-**Beta Start**: November 2025
318
-
-**Feedback Collection**: 2-4 weeks
319
-
-**Bug Fixes & Improvements**: Based on feedback
320
-
-**Release Candidate**: After addressing major feedback
321
-
-**Stable 1.0 Release**: Target Q1 2026
322
-
323
272
## Thank You!
324
273
325
-
Your participation in beta testing helps ensure the Journal Assessment Tool is reliable, accurate, and useful for the research community. We greatly appreciate your time and feedback!
274
+
Your feedback helps ensure Aletheia-Probe remains reliable, accurate, and useful for the research community. We greatly appreciate your time and input in making this tool better for everyone!
0 commit comments