Skip to content

Commit c4bbe4a

Browse files
committed
chore: changelog page added in the docs, CHANGELOG.md link added in README.md
1 parent f74b9c5 commit c4bbe4a

File tree

4 files changed

+80
-0
lines changed

4 files changed

+80
-0
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
### Added
44

5+
- [Changelog page](https://slimeslab.github.io/ComProScanner/about/changelog/) added in the documentation. Also, [CHANGELOG.md](https://github.com/slimeslab/ComProScanner/blob/main/CHANGELOG.md) linked in [README.md](https://github.com/slimeslab/ComProScanner/blob/main/README.md).
6+
57
- Added DeepWiki integration badge to README.md for community Q&A support:
68
- [Ask DeepWiki](https://deepwiki.com/slimeslab/ComProScanner)
79
- Added arXiv preprint badge to README.md:

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -180,6 +180,10 @@ If you use ComProScanner in your research, please cite:
180180
}
181181
```
182182

183+
## Changelog
184+
185+
See the [CHANGELOG](CHANGELOG.md) for details on what has changed in each version.
186+
183187
## Contributing
184188

185189
We welcome contributions! Please see our [Contributing Guidelines](https://slimeslab.github.io/ComProScanner/about/contribution/) for details.

docs/about/changelog.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
## Unreleased
2+
3+
### Added
4+
5+
- [Changelog page](https://slimeslab.github.io/ComProScanner/about/changelog/) added in the documentation. Also, [CHANGELOG.md](https://github.com/slimeslab/ComProScanner/blob/main/CHANGELOG.md) linked in [README.md](https://github.com/slimeslab/ComProScanner/blob/main/README.md).
6+
7+
- Added DeepWiki integration badge to README.md for community Q&A support: [Ask DeepWiki](https://deepwiki.com/slimeslab/ComProScanner)
8+
- Added arXiv preprint badge to README.md: [arXiv:2510.20362](https://arxiv.org/abs/2510.20362)
9+
10+
- [CITATION.cff](https://github.com/slimeslab/ComProScanner/blob/main/CITATION.cff) added for standardized citation information based on the latest release and arXiv preprint.
11+
12+
### Changed
13+
14+
- Moved the README badges section from html `p` tags to markdown format for better compatibility across platforms.
15+
16+
## [0.1.4] - 02-12-2025
17+
18+
### Added
19+
20+
- New function `clean_data()` added for improved data cleaning and preprocessing instead of integrating it into data extraction function.
21+
22+
- New documentation page for Data Cleaning added:
23+
24+
- docs/usage/data-cleaning.md
25+
- Added to mkdocs.yml navigation.
26+
27+
- New API overview documentation page added:
28+
29+
- docs/api.md
30+
- Added to mkdocs.yml navigation.
31+
- New mkdocstrings configuration added to mkdocs.yml for automatic API documentation generation.
32+
33+
- New tests added for remaining utils functions.
34+
35+
- Added pytest coverage tracking (50%) using `pytest-cov` and coverage report generation using _codecov_.
36+
37+
### Fixed
38+
39+
- Tests updated to reflect changes in data cleaning process.
40+
41+
### Removed
42+
43+
- Arguments related to data cleaning removed from data extraction function.
44+
45+
### Changed
46+
47+
- README images updated with raw GitHub links for better reliability: [ComProScanner Logo](https://raw.githubusercontent.com/aritraroy24/ComProScanner/main/assets/comproscanner_logo.png), [ComProScanner Workflow](https://raw.githubusercontent.com/aritraroy24/ComProScanner/main/assets/overall_workflow.png)
48+
49+
## [0.1.3] - 04-11-2025
50+
51+
### Fixed
52+
53+
- **RecursiveCharacterTextSplitter** importing updated for latest _langchain_ version to avoid import errors:
54+
- Changed from `from langchain.text_splitter import RecursiveCharacterTextSplitter`
55+
- To `from langchain.text_splitter.recursive_character import RecursiveCharacterTextSplitter`
56+
57+
## [0.1.2] - 24-10-2025
58+
59+
### Added
60+
61+
- Link to ComProScanner preprint on arXiv in the documentation index page and README.md: [arXiv:2510.20362](https://arxiv.org/abs/2510.20362)
62+
63+
## [0.1.1] - 22-10-2025
64+
65+
### Fixed
66+
67+
- README images updated with external image link to fix PyPI rendering issue. [ComProScanner Logo](https://i.ibb.co/whHSbGvT/comproscanner-logo.png), [ComProScanner Workflow](https://i.ibb.co/QWd2qd3/overall-workflow.png)
68+
69+
## [0.1.0] - 22-10-2025
70+
71+
### Added
72+
73+
- Initial release of ComProScanner.

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -173,6 +173,7 @@ nav:
173173
- About:
174174
- Project Structure: about/project-structure.md
175175
- License: about/license.md
176+
- Changelog: about/changelog.md
176177
- Contribution: about/contribution.md
177178
- Citation: about/citation.md
178179
- Contact: about/contact.md

0 commit comments

Comments
 (0)