Skip to content

docs: fix collection drift and contribution policy#433

Open
shineemad wants to merge 1 commit into
VoltAgent:mainfrom
shineemad:main
Open

docs: fix collection drift and contribution policy#433
shineemad wants to merge 1 commit into
VoltAgent:mainfrom
shineemad:main

Conversation

@shineemad

Copy link
Copy Markdown

Summary

This PR addresses small documentation and metadata inconsistencies found while auditing the repo. All changes are docs/metadata only — no DESIGN.md token content is modified.

Changes

  • Add missing Slack entry to the README collection list (the design-md/slack folder existed but was not listed).
  • Update DESIGN.md count badge from 73 → 74 to match the actual number of site folders.
  • Add design-md/slack/README.md so the folder matches the convention used by every other site.
  • Correct the "Each site includes" table — it referenced preview.html/preview-dark.html files that do not exist in the repo; previews live on getdesign.md.
  • Resolve contradictory contribution instructions in CONTRIBUTING.md (it told contributors to open a PR while also saying DESIGN.md PRs are not accepted).

Why

These were small but cumulative inconsistencies between the docs, the badge count, and the actual folder contents that could erode trust in the curation quality.

Notes

Per the contribution guidelines, fixes are normally maintainer-applied via issues. Opening this as a PR for review since it is limited to documentation/metadata corrections — happy to convert to an issue if preferred.

- Add missing Slack entry to README collection list
- Update DESIGN.md count badge 73 -> 74
- Add README.md for design-md/slack to match folder convention
- Correct 'Each site includes' table (previews live on getdesign.md, not repo)
- Resolve contradictory PR-vs-issue contribution instructions in CONTRIBUTING.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant