awesome-listing compliance: archived entries → separate file + Contributing section - #38
Merged
Merged
Conversation
The Awesome guidelines (sindresorhus/awesome PR checklist) require that unmaintained, archived, or deprecated items be kept out of the main list — 'if you really need to include such items, they should be in a separate Markdown file'. This is a prerequisite for the official awesome listing. - Move the 'Archived or dormant' entries out of README.md into archived.md, keeping the three groupings (archived / 2+ years dormant / ~1.5-2 years). - Drop the section (and its Contents entry) from README.md; add a Footnotes section pointing to archived.md (Footnotes is excluded from the ToC per the same guidelines). - Update CONTRIBUTING.md and AGENTS.md to describe the separate file and the reason for it, so contributors and agents route stale entries correctly. - Update scripts/check-archived.py: any archived repo in README.md is now an error pointing to archived.md (there is no exempt in-README section anymore).
Cafe137
approved these changes
Jul 31, 2026
The awesome submission guidelines recommend linking the contribution guidelines from a dedicated section titled 'Contributing' (top or bottom of the main content), kept out of the Table of Contents — rather than a loose inline reference. Replace the inline 'See CONTRIBUTING.md' line near the top with a '## Contributing' section at the bottom (before Footnotes), linked once to CONTRIBUTING.md so no duplicate-link lint.
crtahlin
changed the title
Collaborator
Author
|
Folded in a second small awesome-compliance change (pushed just now): Add a dedicated
Retitled the PR accordingly. |
yjkellyjoo
approved these changes
Aug 3, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Prerequisite for the official sindresorhus/awesome listing. Their PR checklist (line 69) requires that unmaintained / archived / deprecated items be kept out of the main list: "if you really need to include such items, they should be in a separate Markdown file." Our current in-README Archived or dormant section would fail that check.
What changed
archived.md— holds the archived/dormant entries, keeping the three groupings (archived by maintainers · no activity 2+ years · dormant ~1.5–2 years).README.md— removed theArchived or dormantsection and itsContentsentry; added aFootnotessection linking toarchived.md. Footnotes is intentionally not in the Table of Contents, per the same guidelines (line 96).CONTRIBUTING.md+AGENTS.md— updated so contributors and AI agents route stale entries toarchived.md(not an in-README section), and explain why it's a separate file.scripts/check-archived.py— the archived-repo CI check no longer exempts an in-README section; any archived repo found inREADME.mdis now flagged and pointed toarchived.md.Verification
awesome-lintpasses locally (only pre-existing spell-check warnings in unrelated main-list lines remain).scripts/check-archived.pypasses: no archived repos left inREADME.md.No projects were removed — everything is preserved, just relocated.