← Back to issue list

Docs: Maintenance tasks that improve consistency

View original Github issue

Metadata

Project
charmcraft
Number
#2086
Type
issue
State
open
Author
lengau
Labels
Created
Updated
Closed

Current evaluation

Docs cleanup task to remove 'How to' from how-to guide titles for consistency. No comments or labels; last activity 381 days ago. Several how-to pages already use bare infinitive titles (e.g. 'Manage charms', 'Add an icon to Charmhub'), but the style guide still mandates the 'How to' pattern, so the task is partially done and unresolved.

Suggested action: keep open

Reason: The issue is a maintainer-authored docs task with no labels or comments, but the work is clearly not finished: the doc-style-guide.md still prescribes the 'How to [action] [object]' title pattern, and grep shows many how-to pages retain 'How to' in descriptions/titles. It is a small, well-scoped consistency task that remains valid, so it should stay open rather than be closed as stale.

Impact: 20 Quick Win: 17.0 Staleness: 70 Complexity: 15 Confidence: 70 Support Request: 0

Issue body

### What needs to get done This is a set of small tasks that can be lumped together as they're small and straightforward - Remove "How to" from titles Other tasks as declared by @medubelko before someone takes this up (please edit this issue to add items as you see fit Michael 🙂 ) ### Why it needs to get done Consistency and improvements to docs

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.8-27b
Impact: 20
Quick Win: 17.0
Staleness: 70
Complexity: 15
Confidence: 70
Support Request: 0
keep open Docs cleanup task to remove 'How to' from how-to guide titles for consistency. No comments or labels; last activity 381 days ago. Several how-to pages already use bare infinitive titles (e.g. 'Manage charms', 'Add an icon to Charmhub'), but the style guide still mandates the 'How to' pattern, so the task is partially done and unresolved.
qwen/qwen3.6-35b-a3b
Staleness: 85
Complexity: 10
Confidence: 75
Support Request: 0
close stale Unlabeled documentation maintenance issue from 18 months ago requesting consistency improvements like removing How to from titles. No comments or maintainer engagement since creation.
qwen3.6-35b-a3b-mtp-q6
Staleness: 90
Complexity: 15
Confidence: 85
Support Request: 5
needs triage Documentation maintenance issue tracking small consistency improvements like removing How to from titles. Open for over a year with no comments, labels, or assignee, awaiting assessment.
qwen3.6-35b-a3b-mtp-q6
Staleness: 90
Complexity: 15
Confidence: 80
Support Request: 5
close stale Documentation maintenance issue tracking consistency improvements like removing How to from titles. Open for contributors to pick up and add tasks, but inactive for over a year.
qwen3.6-35b-a3b-mtp-q6
Staleness: 85
Complexity: 10
Confidence: 75
Support Request: 0
close stale Documentation maintenance tasks to improve consistency, starting with removing "How to" from titles. Open for contributors to add and implement changes. Currently unassigned, unreviewed, and inactive for over 300 days.

Update history

No update history recorded yet.

Related issues

No related issues found above the similarity threshold.