Skip to content

Commit cecccc8

Browse files
committed
chore: update project metadata and improve documentation workflows
- Add homepage, repository, and documentation links to pyproject.toml - Include keywords and classifiers for better package discovery - Simplify documentation workflow names and echo messages for clarity - Enhance GitHub Actions workflows for documentation testing and deployment
1 parent 881cb08 commit cecccc8

File tree

3 files changed

+24
-10
lines changed

3 files changed

+24
-10
lines changed

.github/workflows/docs-deploy.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# GitHub Actions workflow to build and deploy the MkDocs documentation
33
# site to GitHub Pages with enhanced CI integration and error handling.
44

5-
name: 📚 Deploy Documentation
5+
name: Deploy Documentation
66

77
# Controls when the workflow will run
88
on:
@@ -99,7 +99,7 @@ jobs:
9999
- name: Run documentation linting
100100
run: |
101101
# Check for broken internal links in markdown files
102-
echo "🔍 Checking documentation quality..."
102+
echo "Checking documentation quality..."
103103
104104
# Basic markdown validation could go here
105105
# You could add markdownlint or other tools

.github/workflows/docs-test.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# GitHub Actions workflow for testing documentation changes
33
# This workflow runs on PRs to validate documentation before deployment
44

5-
name: 🧪 Documentation Tests
5+
name: Documentation Tests
66

77
on:
88
pull_request:
@@ -21,7 +21,7 @@ env:
2121

2222
jobs:
2323
docs-test:
24-
name: 📚 Test Documentation Build
24+
name: Test Documentation Build
2525
runs-on: ubuntu-latest
2626

2727
steps:
@@ -71,7 +71,7 @@ jobs:
7171
7272
- name: Check for broken links
7373
run: |
74-
echo "🔗 Checking for broken internal links..."
74+
echo "Checking for broken internal links..."
7575
# Use a simple grep to find potential broken links
7676
find docs -name "*.md" -exec grep -l "]\(" {} \; | while read file; do
7777
echo "Checking links in: $file"
@@ -96,7 +96,7 @@ jobs:
9696
9797
- name: Check site structure
9898
run: |
99-
echo "🏗️ Checking site structure..."
99+
echo "Checking site structure..."
100100
101101
# Verify critical pages exist
102102
critical_pages=(
@@ -117,7 +117,7 @@ jobs:
117117
118118
- name: Test LED effects assets
119119
run: |
120-
echo "Testing LED effects assets..."
120+
echo "Testing LED effects assets..."
121121
122122
# Check that CSS and JS files are properly included
123123
if ! grep -q "led-text" site/stylesheets/extra.css; then
@@ -135,7 +135,7 @@ jobs:
135135
- name: Generate test report
136136
if: always()
137137
run: |
138-
echo "📊 Documentation Test Report" > docs_test_report.md
138+
echo "Documentation Test Report" > docs_test_report.md
139139
echo "=========================" >> docs_test_report.md
140140
echo "" >> docs_test_report.md
141141
echo "**Build Status:** ${{ job.status }}" >> docs_test_report.md

pyproject.toml

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,22 @@ name = "contextcraft"
55
version = "0.1.0"
66
description = "A CLI toolkit to generate comprehensive project context for LLMs."
77
authors = ["Your Name <you@example.com>"]
8-
license = "MIT" # Or Apache-2.0
9-
readme = "README.md" # if you have one, or poetry will create a default
8+
license = "MIT"
9+
readme = "README.md"
10+
homepage = "https://github.com/Shorzinator/ContextCraft"
11+
repository = "https://github.com/Shorzinator/ContextCraft"
12+
documentation = "https://shorzinator.github.io/ContextCraft/"
13+
keywords = ["llm", "cli", "context", "toolkit", "documentation"]
14+
classifiers = [
15+
"Development Status :: 4 - Beta",
16+
"Intended Audience :: Developers",
17+
"License :: OSI Approved :: MIT License",
18+
"Programming Language :: Python :: 3.9",
19+
"Programming Language :: Python :: 3.10",
20+
"Programming Language :: Python :: 3.11",
21+
"Topic :: Software Development :: Documentation",
22+
"Topic :: Utilities"
23+
]
1024

1125
[tool.poetry.dependencies]
1226
python = "^3.9"

0 commit comments

Comments
 (0)