Skip to content

Commit 53233d0

Browse files
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>
1 parent f89dc03 commit 53233d0

File tree

2 files changed

+36
-89
lines changed

2 files changed

+36
-89
lines changed

README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@
44
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
55
[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
66

7-
> **🚧 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-
97
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.
108

119
**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:
2624
```
2725

2826
```bash
29-
# Beta release - Install from PyPI or source
27+
# Install from PyPI or source
3028
31-
# Option 1: Install from PyPI (recommended for beta testing)
29+
# Option 1: Install from PyPI (recommended)
3230
pip install aletheia-probe
3331
3432
# Option 2: Install from source (for development)

BETA-TESTING.md renamed to docs/feedback.md

Lines changed: 34 additions & 85 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,30 @@
1-
# Beta Testing Guide
1+
# Providing Feedback
22

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.
44

5-
## Current Status: Beta v0.1.0
5+
## Current Features
66

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.
88

9-
## What to Expect
9+
## Tool Capabilities
1010

11-
### What Works Well
12-
- ✅ Core journal assessment functionality
11+
### Core Features
12+
- ✅ Comprehensive journal assessment functionality
13+
- ✅ Conference assessment capabilities
1314
- ✅ Multiple data source integration (DOAJ, Beall's List, Retraction Watch, OpenAlex, etc.)
1415
- ✅ BibTeX file batch processing
15-
- ✅ JSON and text output formats
16-
- ✅ Configuration management
17-
- ✅ Cache synchronization
18-
- ✅ Comprehensive documentation
19-
- ✅ All 179 unit and integration tests passing
16+
- ✅ Multiple output formats (JSON, text, verbose)
17+
- ✅ Flexible configuration management
18+
- ✅ Automatic data source synchronization
19+
- ✅ Extensive documentation and examples
2020

21-
### Known Limitations
21+
### Current Limitations
2222
- ⚠️ **First sync takes time**: Initial data download can take 5-10 minutes depending on your connection
23-
- ⚠️ **Coverage gaps**: Some edge cases in batch processing and OpenAlex integration may not be fully tested
2423
- ⚠️ **Regional journals**: Journals from non-Western regions may have limited coverage in data sources
2524
- ⚠️ **New journals**: Very recently launched journals (< 1 year) may return "insufficient_data"
25+
- ⚠️ **Conference coverage**: Limited compared to journal assessment due to fewer comprehensive conference databases
2626

27-
### What We Need Feedback On
27+
## Areas Where We Value Your Feedback
2828
1. **Installation experience** - Any issues or confusion during setup?
2929
2. **Real-world usage** - Does it work with your actual reference files?
3030
3. **Performance** - How long do assessments take for your use cases?
@@ -33,58 +33,15 @@ This is a **pre-release version** intended for testing and feedback. The core fu
3333
6. **Platform issues** - Any problems on your OS (Linux/macOS/Windows)?
3434
7. **Error handling** - How does it behave with malformed inputs?
3535

36-
## Installation
36+
## Getting Started
3737

38-
### Prerequisites
39-
- Python 3.10 or higher
40-
- Internet connection (for data source access)
38+
For installation instructions and basic usage, please see:
39+
- [Quick Start Guide](quick-start.md) - Installation and first steps
40+
- [User Guide](user-guide.md) - Comprehensive usage examples
4141

42-
### Installation Methods
42+
## Common Usage Scenarios
4343

44-
#### Option 1: Install from PyPI (Recommended)
45-
46-
```bash
47-
# 1. Create a virtual environment (recommended)
48-
python -m venv venv
49-
source venv/bin/activate # On Windows: venv\Scripts\activate
50-
51-
# 2. Install from PyPI
52-
pip install aletheia-probe
53-
54-
# 3. Verify installation
55-
aletheia-probe --version
56-
# Should output: aletheia-probe version 0.1.0
57-
58-
# 4. Initial data synchronization (takes 3-5 minutes)
59-
aletheia-probe sync
60-
```
61-
62-
#### Option 2: Install from Source (For Development)
63-
64-
```bash
65-
# 1. Clone the repository
66-
git clone https://github.com/sustainet-guardian/aletheia-probe.git
67-
cd aletheia-probe
68-
69-
# 2. Create a virtual environment (recommended)
70-
python -m venv venv
71-
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:
8845

8946
### 1. Basic Single Journal Assessment
9047

@@ -181,10 +138,10 @@ time aletheia-probe bibtex large_references.bib
181138
## Reporting Issues
182139

183140
### Before Reporting
184-
1. Check the [Troubleshooting Guide](docs/troubleshooting.md)
141+
1. Check the [Troubleshooting Guide](troubleshooting.md)
185142
2. Search [existing issues](https://github.com/sustainet-guardian/aletheia-probe/issues)
186143
3. Try with `--verbose` flag for more details
187-
4. Test with latest version from `main` branch
144+
4. Ensure you're using the latest version
188145

189146
### How to Report
190147

@@ -224,7 +181,7 @@ When creating issues, please suggest appropriate labels:
224181
- `documentation` - Documentation issues or improvements
225182
- `question` - Questions about usage or behavior
226183
- `performance` - Performance-related issues
227-
- `beta-feedback` - General beta testing feedback
184+
- `feedback` - General user feedback
228185

229186
## Expected Behavior vs. Bugs
230187

@@ -267,19 +224,19 @@ Beyond bug reports, we welcome general feedback on:
267224
- What's missing for your needs?
268225

269226
Please share feedback by:
270-
- Creating a GitHub issue with the `beta-feedback` label
227+
- Creating a GitHub issue with the `feedback` label
271228
- Discussing in GitHub Discussions (if enabled)
272229
- Emailing maintainers (check CONTRIBUTING.md for contacts)
273230

274-
## Testing Checklist
231+
## Feedback Checklist
275232

276-
Use this checklist to guide your testing:
233+
Use this checklist to help provide comprehensive feedback:
277234

278235
**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
281238
- [ ] First `sync` completed without errors
282-
- [ ] `aletheia-probe status` shows data synced
239+
- [ ] `aletheia-probe status` shows data properly synced
283240

284241
**Basic Functionality**
285242
- [ ] Assess a well-known journal with `journal` command (e.g., "Nature")
@@ -312,21 +269,13 @@ Use this checklist to guide your testing:
312269
- [ ] Troubleshooting guide helped resolve issues
313270
- [ ] No major gaps in documentation
314271

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-
323272
## Thank You!
324273

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!
326275

327276
## Questions?
328277

329-
- Check the [User Guide](docs/user-guide.md)
330-
- Review [Troubleshooting](docs/troubleshooting.md)
278+
- Check the [User Guide](user-guide.md)
279+
- Review [Troubleshooting](troubleshooting.md)
331280
- Create an issue with the `question` label
332-
- See [CONTRIBUTING.md](.github/community/CONTRIBUTING.md) for development questions
281+
- See [CONTRIBUTING.md](../.github/community/CONTRIBUTING.md) for development questions

0 commit comments

Comments
 (0)