Skip to content
This repository was archived by the owner on Apr 7, 2026. It is now read-only.

Commit cee0d26

Browse files
committed
fix: Improve badges and documentation formatting
- Fix CI badge to point to correct workflow (test.yml instead of ci.yml) - Add Documentation badge linking to GitHub Pages site - Fix improperly formatted warning and info admonitions in docs/index.md - Add proper titles to warning and info notices for better rendering - Ensure all badges now render correctly and link to appropriate resources
1 parent fbf3b66 commit cee0d26

2 files changed

Lines changed: 8 additions & 4 deletions

File tree

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22

33
A modern [cookiecutter](https://github.com/cookiecutter/cookiecutter) template for Python packages with best practices built-in.
44

5-
[![CI](https://github.com/s-celles/cookiecutter-python-package/actions/workflows/ci.yml/badge.svg)](https://github.com/s-celles/cookiecutter-python-package/actions/workflows/ci.yml)
5+
[![CI](https://github.com/s-celles/cookiecutter-python-package/actions/workflows/test.yml/badge.svg)](https://github.com/s-celles/cookiecutter-python-package/actions/workflows/test.yml)
6+
[![Documentation](https://github.com/s-celles/cookiecutter-python-package/actions/workflows/docs.yml/badge.svg)](https://s-celles.github.io/cookiecutter-python-package/)
67
[![Python versions](https://img.shields.io/badge/python-3.9%2B-blue.svg)](https://www.python.org/downloads/)
78
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
89

docs/index.md

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

33
A modern [cookiecutter](https://github.com/cookiecutter/cookiecutter) template for Python packages with best practices built-in.
44

5-
[![CI](https://github.com/s-celles/cookiecutter-python-package/actions/workflows/ci.yml/badge.svg)](https://github.com/s-celles/cookiecutter-python-package/actions/workflows/ci.yml)
5+
[![CI](https://github.com/s-celles/cookiecutter-python-package/actions/workflows/test.yml/badge.svg)](https://github.com/s-celles/cookiecutter-python-package/actions/workflows/test.yml)
6+
[![Documentation](https://github.com/s-celles/cookiecutter-python-package/actions/workflows/docs.yml/badge.svg)](https://s-celles.github.io/cookiecutter-python-package/)
67
[![Python versions](https://img.shields.io/badge/python-3.9%2B-blue.svg)](https://www.python.org/downloads/)
78
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
89

@@ -12,9 +13,11 @@ A modern [cookiecutter](https://github.com/cookiecutter/cookiecutter) template f
1213
cookiecutter https://github.com/s-celles/cookiecutter-python-package.git
1314
```
1415

15-
!!! warning This project is currently in active development.
16+
!!! warning "Development Status"
17+
This project is currently in active development.
1618

17-
!!! info "AI-Generated Content Notice" A significant portion of this project's content (including code, documentation, and examples) has been generated using AI assistance. Please review all code and documentation carefully before use in production environments. We recommend thorough testing and validation of any AI-generated components.
19+
!!! info "AI-Generated Content Notice"
20+
A significant portion of this project's content (including code, documentation, and examples) has been generated using AI assistance. Please review all code and documentation carefully before use in production environments. We recommend thorough testing and validation of any AI-generated components.
1821

1922
## What You Get
2023

0 commit comments

Comments
 (0)