Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Review and prune outdated docs #19214

Open
1 task done
colindean opened this issue Feb 3, 2025 · 1 comment
Open
1 task done

Review and prune outdated docs #19214

colindean opened this issue Feb 3, 2025 · 1 comment
Labels
features New features

Comments

@colindean
Copy link
Contributor

Verification

Provide a detailed description of the proposed feature

The Docs team at AGM surfaced a need to review all docs (tracking enabled by @issyl0's #19200) and prune docs that are outdated, all or in part.

Notably, https://docs.brew.sh/Checksum_Deprecation could likely be dropped entirely.

What is the motivation for the feature?

Outdated docs are noisy to users who are browsing the docs for a solution. Regular review of our documentation is worthwhile to ensure current accuracy.

How will the feature be relevant to at least 90% of Homebrew users?

Homebrew users who read documentation would love an affirmation that the documentation is up to date or to know that a document may be out of date because it hasn't been reviewed in a long time.

What alternatives to the feature have been considered?

No action would leave outdated docs in place and not institute a review effort.

We consider tooling to list unreviewed docs out of scope for this.

@colindean colindean added the features New features label Feb 3, 2025
@MikeMcQuaid
Copy link
Member

Woohoo!

prune docs that are outdated, all or in part.

We should ensure that these docs are not linked legitimately/too widely online and not at all by our own repos/tools before doing this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
features New features
Projects
None yet
Development

No branches or pull requests

2 participants