← 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 consistency meta-issue to remove “How to” from guide titles; it lacks a defined task list and conflicts with current guidance requiring that prefix.

Suggested action: needs triage

Reason: The issue has no labels, assignee, or comments, and explicitly leaves room for additional tasks, so its final scope is undefined. Current guidance says how-to guide titles should follow “How to [action] [object],” while inspected guide titles such as “Add an icon to Charmhub” already omit the prefix, creating a policy contradiction that needs maintainer triage.

Evaluated by: mr-cal-bot

Impact: 15 Quick Win: 6 Complexity: 20 Confidence: 91 Actionability: 48

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
stealth/space-bunny-alpha
Impact: 15
Quick Win: 6
Complexity: 20
Confidence: 91
Actionability: 48
needs triage Docs consistency meta-issue to remove “How to” from guide titles; it lacks a defined task list and conflicts with current guidance requiring that prefix.
qwen/qwen3.6-35b-a3b
Impact: 20
Quick Win: 5
Complexity: 10
Confidence: 60
Actionability: 30
needs triage Documentation maintenance meta-issue for improving consistency, specifically removing 'How to' from titles. No labels or maintainer comments.
qwen/qwen3.8-27b
Impact: 20
Quick Win: 17
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.

Update history

No update history recorded yet.

Related issues

No related issues found above the similarity threshold.