Skip to content

(docs) Update README with cleaned junk categories#25

Merged
Vortrix5 merged 1 commit into
Vortrix5:mainfrom
avatGit:docs/list-junk-categories
Jun 17, 2026
Merged

(docs) Update README with cleaned junk categories#25
Vortrix5 merged 1 commit into
Vortrix5:mainfrom
avatGit:docs/list-junk-categories

Conversation

@avatGit

@avatGit avatGit commented Jun 14, 2026

Copy link
Copy Markdown
Contributor

What does this PR do?

This PR addresses the issue requesting a documented list of the junk categories covered by sifty junk scan inside the README. It adds a clear bulleted list explaining each of the 11 core categories and highlights which one is disabled by default.
Closes #21

Notes for the reviewer

  • 11 Categories: For now, this list strictly documents the current 11 baseline categories from main.
  • Discord Cache Note: I am intentionally leaving out the discord-cache category from this list for the moment to avoid dependency conflicts with my other pending PR((feat) add Discord cache category to junk cleaner #24 ). Once the Discord cache PR is merged into main, I will gladly open a quick follow-up commit/PR to bump the count to 12 and add it to this list.

@github-actions

Copy link
Copy Markdown

Thanks for your first pull request to Sifty! A couple of things that help it land quickly: Sifty deletes files, so all deletion must go through safety.trash() and destructive paths default to dry-run. Please make sure pytest is green (especially tests/test_safety.py) and that the PR title starts with a type tag like (feat) or (fix). See CONTRIBUTING.md for the full checklist. A maintainer will review shortly.

@github-actions github-actions Bot added the docs Documentation label Jun 14, 2026
@Vortrix5

Copy link
Copy Markdown
Owner

Hello, your PR #24 has been successfully merged. Could you please bump the count to 12 and add it to this list?

@avatGit

avatGit commented Jun 15, 2026

Copy link
Copy Markdown
Contributor Author

Updated! I included discord-cache in the README list and bumped the count to 12 categories.

@Vortrix5 Vortrix5 left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for picking this up, but the list doesn't match the actual categories in src/sifty/core/junk.py and needs a redo before it can go in.

It lists four that don't exist anywhere in the code: delivery-optimization, branchcache, log-files, and recycle-bin. And it misses several real ones: thumbnail-cache, winget-cache, event-log-archives, defender-history, onedrive-logs, and windows-old (off by default). One small thing too: browser-cache also covers Brave/Vivaldi/Firefox, not just Chrome/Edge.

Easiest fix is to generate the list straight from junk_categories() so it stays accurate, ideally grouped by always-on vs off-by-default (downloads-installers, windows-old) and which ones need admin. Happy to re-review once it matches the code.

@github-actions github-actions Bot added the area: cli Typer CLI frontend label Jun 15, 2026
@codecov-commenter

Copy link
Copy Markdown

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

ℹ️ You can also turn on project coverage checks and project coverage reporting on Pull Request comment

Thanks for integrating Codecov - We've got you covered ☂️

@avatGit

avatGit commented Jun 15, 2026

Copy link
Copy Markdown
Contributor Author

Sorry about that, I missed it the first time. I've redone the list from scratch using junk_categories() only, grouped by activation status (Always-On vs Off by Default), with Requires Admin tags and updated browser descriptions. Take another look and let me know!

@Vortrix5 Vortrix5 left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The category list itself is fixed now, nice work, it matches junk_categories() and the always-on vs off-by-default split is exactly right.

The rebase dragged in some unrelated stuff though, so it's not mergeable as docs-only yet. Three things:

  1. It removes the PyPI and Codecov badges from the README header. main still has both, so this would delete them. Please put them back.
  2. It also carries the thousands-separator CLI change across 11 files. That's #23, which is already merged to main. Rebasing onto the latest main should drop those (they're identical), leaving just the README change.
  3. The "How it compares" table got reformatted (column padding, metadata to metadata), looks like a markdown formatter ran. Can you revert that so the diff is only the new section? Keeps it reviewable.

Once it's back to a docs-only diff with the badges intact, happy to merge. Thanks for turning the list around.

@avatGit avatGit force-pushed the docs/list-junk-categories branch from d80172c to e7e572d Compare June 15, 2026 23:34
@github-actions github-actions Bot removed the area: cli Typer CLI frontend label Jun 15, 2026
@avatGit avatGit force-pushed the docs/list-junk-categories branch from e7e572d to 003e5dd Compare June 15, 2026 23:42
@avatGit

avatGit commented Jun 15, 2026

Copy link
Copy Markdown
Contributor Author

Synced with latest main, badges are back, and I turned off my auto-formatter so the table stays exactly as-is. The diff only touches the new categories section. Thanks for your guidance, i am ready for re-review

@Vortrix5 Vortrix5 merged commit b43e986 into Vortrix5:main Jun 17, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document the junk categories in the README

3 participants