Project Status

Last Updated: 2026-02-20

Quick Status¶

Validation Status¶

Code-to-Text Ratio Achievement¶

Target: 3:1 code examples to explanatory text

Overall Ratio: 2.38:1 ⚠️
Passing Guides: 18/20 (90.0%) ✅
Progress: 79% toward 3:1 target
Total Code Lines: 26,355
Total Text Lines: 11,084

Language Guide	Code Lines	Text Lines	Ratio	Status
github_actions	1,879	228	8.24	✅ PASS
kubernetes	1,578	210	7.51	✅ PASS
ansible	2,258	329	6.86	✅ PASS
gitlab_ci	2,138	323	6.62	✅ PASS
jenkins_groovy	1,592	261	6.10	✅ PASS
terragrunt	1,079	181	5.96	✅ PASS
hcl	1,351	236	5.72	✅ PASS
sql	1,181	210	5.62	✅ PASS
bash	1,330	244	5.45	✅ PASS
powershell	1,439	268	5.37	✅ PASS
dockerfile	1,116	218	5.12	✅ PASS
cdk	1,074	212	5.07	✅ PASS
yaml	1,172	244	4.80	✅ PASS
typescript	968	209	4.63	✅ PASS
docker_compose	1,001	234	4.28	✅ PASS
makefile	1,166	274	4.26	✅ PASS
json	879	239	3.68	✅ PASS
python	1,012	318	3.18	✅ PASS
terraform	2,123	6,285	0.34	❌ FAIL
comparison_matrix	19	361	0.05	❌ FAIL

Guides Below Target¶

2 guide(s) need improvement to reach 3:1 ratio:

comparison_matrix (0.05:1)
Current: 19 code lines, 361 text lines
Needs: ~1,064 more code lines or reduced text
terraform (0.34:1)
Current: 2,123 code lines, 6,285 text lines
Needs: ~16,732 more code lines or reduced text

Link Checker Status¶

Status: ✅ PASSING
Last Run: Weekly (automated)
Configuration: .github/markdown-link-check-config.json
Workflow: .github/workflows/link-checker.yml

Spell Checker Status¶

Status: ✅ PASSING (Blocking quality gate)
Files Checked: All Markdown files
Whitelisted Terms: 275+ technical terms
Configuration: .github/cspell.json
Workflow: .github/workflows/spell-checker.yml
Last Run: Weekly + on every PR

Project Statistics¶

Documentation Overview¶

Total Documentation Pages: 74
Language Guides: 20
Templates: 13
CI/CD Guides: Multiple
Examples: Multiple
Categories: 11+

Code Quality Metrics¶

Pre-commit Hooks: 15+ configured
Active Linters: 8
black (Python formatting, 100 char line)
flake8 (Python linting)
yamllint (YAML validation, 120 char line)
shellcheck (Bash validation)
markdownlint (Markdown standards)
terraform_fmt, terraform_validate
terraform_docs

Release Information¶

Current Version: 1.8.0
Latest Release: v1.8.0 (2026-02-20)
Total Releases: 6
License: MIT
Repository: tydukes/coding-style-guide
Documentation Site: https://tydukes.github.io/coding-style-guide/

Repository Activity¶

Total Commits: 347
Contributors: 5
Open Issues: 11
Closed Issues: Tracked via milestones
Open Pull Requests: 0
Merged Pull Requests: 104

Quality Gates¶

All quality gates must pass before merging to main branch.

Quality Gate	Status	Blocking	Details
Build	✅ PASSING	Yes	MkDocs builds with `--strict` flag
Pre-commit Hooks	✅ PASSING	Yes	All 15+ hooks pass
Linters	✅ PASSING	Yes	Black, Flake8, yamllint, shellcheck
Spell Check	✅ PASSING	Yes	Blocks merge on errors
Link Check	✅ PASSING	No	Weekly validation
Metadata Validation	⚠️ WARNING	No	Non-blocking warnings
Code-to-Text Ratio	✅ PASSING	No	Target: 100% (20/20 guides)

Recent Achievements¶

Version 1.8.0 Highlights¶

Tutorial series: five hands-on step-by-step walkthroughs
Progressive enhancement maturity model and adoption roadmap
Language interoperability guide
Developer experience: shell aliases, REPL guide, git hooks library
Dark mode, print styles, copy code buttons, improved search
Related pages suggestions and bookmarks system
CI/CD performance optimization guide
Documentation versioning and changelog automation guides
Multiple dependency updates and broken link fixes

View Full Changelog →

Code-to-Text Ratio Progress¶

Improvement Timeline:

Initial State: 11/19 guides passing (58%)
Mid-Project: 14/19 guides passing (74%)
Recent: 17/19 guides passing (89%)
Current: 18/20 guides passing (90.0%) ⬆️

Key Achievements:

Added 15,000+ lines of code examples
Reduced explanatory text by 30%
Improved overall ratio from 1.89:1 to 2.38:1
On track to achieve 3:1 target across all guides

CI/CD Pipeline¶

Automated Workflows¶

Active GitHub Actions Workflows:

ci.yml - Main CI Pipeline
Triggers: Push/PR to main
Validates metadata, runs linters, builds docs
Uploads documentation artifacts
deploy.yml - Documentation Deployment
Triggers: Push to main
Deploys to GitHub Pages
Updates live documentation site
container.yml - Container Build & Publish
Triggers: Push to main, tags, PRs
Multi-platform: linux/amd64, linux/arm64
Publishes to: ghcr.io/tydukes/coding-style-guide
spell-checker.yml - Spelling Validation (BLOCKING)
Triggers: Push/PR, weekly schedule
Creates issues on failures
Comments on PRs with errors
link-checker.yml - Link Validation
Triggers: Push/PR, weekly schedule
Auto-creates issues for broken links
Labeled with broken-links
auto-merge.yml - Automated PR Merging
Triggers: After CI success
Auto-merges: dependabot, tydukes
Strategy: Squash merge
dashboard.yml - Dashboard Updates (NEW)
Triggers: Weekly, on doc changes, manual
Auto-updates project status metrics
Commits changes to main branch

Pre-commit Hook Coverage¶

File checks (trailing whitespace, EOF, large files)
YAML validation (with unsafe flag)
JSON validation
Merge conflict detection
Private key detection
Mixed line ending detection
Python: Black + Flake8
YAML: yamllint
Shell: shellcheck
Markdown: markdownlint
Terraform: format, validate, docs

Open Work¶

Current Focus Areas¶

Active Issues by Label:

type:docs — Documentation improvements
type:feature — Feature additions
type:maintenance — Automation and tooling
scope:language-guide — Language guide updates

View All Open Issues →

Upcoming Milestones¶

Ongoing — Quality & Coverage:

Achieve 3:1 code-to-text ratio across all applicable guides
Add more real-world examples
Enhance testing documentation
Improve automation tooling

View Milestones →

Container Usage¶

The project is published as a Docker container for use as a validation tool in other projects.

Published to: ghcr.io/tydukes/coding-style-guide:latest

Available Commands:

# Run full validation suite
docker run --rm -v $(pwd):/workspace ghcr.io/tydukes/coding-style-guide:latest validate

# Run linters only
docker run --rm -v $(pwd):/workspace ghcr.io/tydukes/coding-style-guide:latest lint

# Auto-format code
docker run --rm -v $(pwd):/workspace ghcr.io/tydukes/coding-style-guide:latest format

# Build documentation
docker run --rm -v $(pwd):/workspace ghcr.io/tydukes/coding-style-guide:latest docs

# Validate metadata tags
docker run --rm -v $(pwd):/workspace ghcr.io/tydukes/coding-style-guide:latest metadata

# Show help
docker run --rm ghcr.io/tydukes/coding-style-guide:latest help

Contributing¶

We welcome contributions! See our guides:

Support¶

Issues: GitHub Issues
Documentation: https://tydukes.github.io/coding-style-guide/

This dashboard is automatically updated weekly and on documentation changes.