craftcms / craftcms/docs

[Content]: Improve descriptions for cache/* and clear-caches/* console commands

Open
#730 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

📦 CMS
Dominant language
JavaScript
Stars
42
Forks
160
Avg merge
3h 9m
Merged PRs (30d)
4

Description

Product

Craft CMS

Description

I've long been confused about some of the cache/* and clear-caches/* console commands, and I'm sure I'm not the only one.

It would be greatly appreciated if these could be improved to detail exactly which files, folders, database tables, etc are cleared out when running these commands. Some like clear-caches/cp-resources are easily apparent, but just to have full clarification on all of them would bring a lot of peace of mind.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked Craft CMS CLI reference sections for cache/* and clear-caches/*. Review every command description and verify what each command clears, including files, folders, and database tables. Done means the documentation clearly identifies the affected resources for all commands, including those whose behavior is not immediately apparent.

Written by the indexing model from the issue text.

Assessment

Domain
cli, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.