Skip to content

docs: improve repo discoverability and add community files - #27

Merged
mazzma12 merged 2 commits into
crowdsecurity:mainfrom
mazzma12:docs/readme-discoverability
Sep 25, 2026
Merged

mazzma12 merged 2 commits into
crowdsecurity:mainfrom
mazzma12:docs/readme-discoverability

Conversation

@mazzma12

Copy link
Copy Markdown
Collaborator

Implements the non-metadata items from the discoverability audit: README title/opening rewritten to state what the plugin is and which agents it targets, version badge now reads plugin.json at render time (CI guards the two manifests but nothing guarded the badge — it read 0.2.3 against 0.3.0), emoji removed from headings for stable anchors, and a Reference docs index linking the 37 references/ files that previously had no inbound links.
Two factual fixes found while writing it: the Install row listed OpnSense but the install doc is pfSense (OPNsense/FreeBSD is covered under configure/ and appsec/, not install/), and a doc link pointed at doc.crowdsec.net instead of docs.crowdsec.net. CLAUDE.md's install/ layout row was missing pfsense.md.
⚠️ CODE_OF_CONDUCT.md ships with a <CONTACT> placeholder — no conduct address exists anywhere in the org and security@crowdsec.net is vulnerability-only, so it needs filling before merge.

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Comment thread CODE_OF_CONDUCT.md Outdated
@@ -0,0 +1,82 @@
name: Bug report
description: Something in the skill is wrong, stale, or doesn't work

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

yes to have a template that asks the user/agent to fill area etc. not found of the more "closed" approach with dropdown lists.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Done in f1f4d19 — both dropdowns (Area, Environment) are now type: input free text, with the options moved into placeholder as hints rather than a fixed list. Nothing is constrained now; an agent or a human can write whatever fits.

@@ -0,0 +1,46 @@
name: Coverage request
description: Ask for a new environment, bouncer, or workflow to be covered
labels: ["enhancement"]

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

same as for issues

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Same change applied — the checkboxes block is now a free-text Can you test it? textarea, and I added an open Area field to match the bug form.

Comment thread CHANGELOG.md Outdated
Comment thread CODE_OF_CONDUCT.md Outdated
@@ -0,0 +1,119 @@
# Contributor Covenant Code of Conduct

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

no COC

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Removed in f1f4d19.

Comment thread README.md Outdated
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@mazzma12
mazzma12 merged commit 8802dbe into crowdsecurity:main Sep 25, 2026
2 checks passed
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.

2 participants