Repository navigation
revamp the whole faq section - #1213
Merged
Merged
Conversation
Resolve conflicts with #1101 (CAPI rate limiting): - security_engine.mdx stays removed; its new `cscli capi status` health-check warning moves to troubleshooting/configuration. - intro and sidebar keep the symptom-first layout; the intro table gains a Central API 403 / rate limiting row. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The change introduces broken documentation links, misrepresents what triggers suspicious-browser-submission, and drops six existing troubleshooting URL aliases.
2 open issues
What changed in this PR
Reorganizes CrowdSec’s FAQ into symptom-based troubleshooting guides, connecting them with Stack Health checks and existing reference documentation.
Changes:
- Replaces component-wide troubleshooting pages with focused guides for startup, detection, blocking, false positives, bot detection, configuration, and general questions.
- Rewrites IP-reputation guidance and updates related links across current and versioned documentation.
- Restructures navigation, moves Use Cases to Getting Started, adds redirects, and marks planned health checks as unlisted.
| File | Description |
|---|---|
| crowdsec-docs/versioned_docs/version-v1.8/observability/usage_metrics.md | Updates custom/tainted item link. |
| crowdsec-docs/versioned_docs/version-v1.8/log_processor/intro.mdx | Updates configuration-directory link. |
| crowdsec-docs/versioned_docs/version-v1.8/log_processor/alert_context/intro.md | Updates configuration-path link. |
| crowdsec-docs/versioned_docs/version-v1.8/local_api/configuration.md | Updates configuration-location links. |
| crowdsec-docs/versioned_docs/version-v1.8/local_api/authentication.md | Updates credentials-directory link. |
| crowdsec-docs/versioned_docs/version-v1.8/configuration/network_management.md | Updates proxy guidance link. |
| crowdsec-docs/versioned_docs/version-v1.8/concepts.md | Updates Central API opt-out link. |
| crowdsec-docs/versioned_docs/version-v1.8/central_api/intro.md | Updates signal-sharing opt-out link. |
| crowdsec-docs/versioned_docs/version-v1.7/observability/usage_metrics.md | Updates custom/tainted item link. |
| crowdsec-docs/versioned_docs/version-v1.7/log_processor/intro.mdx | Updates configuration-directory link. |
| crowdsec-docs/versioned_docs/version-v1.7/log_processor/alert_context/intro.md | Updates configuration-path link. |
| crowdsec-docs/versioned_docs/version-v1.7/local_api/configuration.md | Updates configuration-location links. |
| crowdsec-docs/versioned_docs/version-v1.7/local_api/authentication.md | Updates credentials-directory link. |
| crowdsec-docs/versioned_docs/version-v1.7/configuration/network_management.md | Updates proxy guidance link. |
| crowdsec-docs/versioned_docs/version-v1.7/concepts.md | Updates Central API opt-out link. |
| crowdsec-docs/versioned_docs/version-v1.7/central_api/intro.md | Updates signal-sharing opt-out link. |
| crowdsec-docs/versioned_docs/version-v1.6/observability/usage_metrics.md | Updates custom/tainted item link. |
| crowdsec-docs/versioned_docs/version-v1.6/log_processor/intro.mdx | Updates configuration-directory link. |
| crowdsec-docs/versioned_docs/version-v1.6/log_processor/alert_context/intro.md | Updates configuration-path link. |
| crowdsec-docs/versioned_docs/version-v1.6/local_api/configuration.md | Updates configuration-location links. |
| crowdsec-docs/versioned_docs/version-v1.6/local_api/authentication.md | Updates credentials-directory link. |
| crowdsec-docs/versioned_docs/version-v1.6/central_api/intro.md | Updates signal-sharing opt-out link. |
| crowdsec-docs/unversioned/troubleshooting/startup_errors.mdx | Adds service, log, and startup-error guidance. |
| crowdsec-docs/unversioned/troubleshooting/security_engine.mdx | Removes the monolithic Security Engine FAQ. |
| crowdsec-docs/unversioned/troubleshooting/remediation_components.mdx | Removes the component-wide troubleshooting page. |
| crowdsec-docs/unversioned/troubleshooting/not_detecting.mdx | Adds detection-pipeline troubleshooting. |
| crowdsec-docs/unversioned/troubleshooting/not_blocking.mdx | Adds decision and blocking diagnostics. |
| crowdsec-docs/unversioned/troubleshooting/issue_se_too_many_alerts.md | Links to false-positive guidance. |
| crowdsec-docs/unversioned/troubleshooting/issue_se_self_report.md | Updates allowlisting guidance link. |
| crowdsec-docs/unversioned/troubleshooting/issue_se_offline.md | Updates proxy and startup links. |
| crowdsec-docs/unversioned/troubleshooting/issue_se_no_alerts.md | Links to detection and CDN troubleshooting. |
| crowdsec-docs/unversioned/troubleshooting/issue_se_no_active_rc.md | Updates remediation troubleshooting link. |
| crowdsec-docs/unversioned/troubleshooting/issue_lp_offline.md | Updates log and startup guidance links. |
| crowdsec-docs/unversioned/troubleshooting/issue_lp_no_alerts.md | Updates CDN troubleshooting link. |
| crowdsec-docs/unversioned/troubleshooting/issue_integration_rc_offline.md | Updates remediation troubleshooting link. |
| crowdsec-docs/unversioned/troubleshooting/issue_capi_403.md | Links to startup-error guidance. |
| crowdsec-docs/unversioned/troubleshooting/intro.md | Adds symptom-based navigation and support options. |
| crowdsec-docs/unversioned/troubleshooting/general.md | Adds resource, performance, license, and sharing FAQs. |
| crowdsec-docs/unversioned/troubleshooting/future_console_issues.md | Marks planned health checks as unlisted. |
| crowdsec-docs/unversioned/troubleshooting/false_positives.mdx | Adds unbanning, allowlisting, and simulation guidance. |
| crowdsec-docs/unversioned/troubleshooting/cti.mdx | Rewrites flagged-IP and safe-classification guidance. |
| crowdsec-docs/unversioned/troubleshooting/console_issues.md | Replaces planned-check details with a roadmap link. |
| crowdsec-docs/unversioned/troubleshooting/configuration.mdx | Consolidates configuration and operational FAQs. |
| crowdsec-docs/unversioned/troubleshooting/bot_detection.mdx | Adds challenge and bot-detection diagnostics. |
| crowdsec-docs/unversioned/troubleshooting/billing_faq.mdx | Adds descriptive page metadata. |
| crowdsec-docs/unversioned/getting_started/usecases.mdx | Moves existing use cases into Getting Started. |
| crowdsec-docs/unversioned/getting_started/post_installation/acquisition_troubleshoot.mdx | Updates log-location link. |
| crowdsec-docs/unversioned/getting_started/installation/whm.mdx | Links to the new troubleshooting overview. |
| crowdsec-docs/unversioned/getting_started/health_check.mdx | Connects health checks to focused troubleshooting. |
| crowdsec-docs/unversioned/cti_api/taxonomy/false_positives.mdx | Links to centralized safe-classification instructions. |
| crowdsec-docs/src/components/home-page/features.tsx | Updates the homepage license link. |
| crowdsec-docs/sidebarsUnversioned.ts | Reorganizes troubleshooting and relocates Use Cases. |
| crowdsec-docs/docusaurus.config.ts | Adds redirects and excludes draft content from AI indexing. |
| crowdsec-docs/docs/observability/usage_metrics.md | Updates custom/tainted item link. |
| crowdsec-docs/docs/log_processor/intro.mdx | Updates configuration-directory link. |
| crowdsec-docs/docs/log_processor/alert_context/intro.md | Updates configuration-path link. |
| crowdsec-docs/docs/local_api/configuration.md | Updates configuration-location links. |
| crowdsec-docs/docs/local_api/authentication.md | Updates credentials-directory link. |
| crowdsec-docs/docs/configuration/network_management.md | Updates proxy guidance link. |
| crowdsec-docs/docs/concepts.md | Updates Central API opt-out link. |
| crowdsec-docs/docs/central_api/intro.md | Updates signal-sharing opt-out link. |
Review effort: Balanced
Comment on lines
+201
to
+203
| { from: "/u/troubleshooting/security_engine", to: "/u/troubleshooting/intro" }, | ||
| { from: "/u/troubleshooting/remediation_components", to: "/u/troubleshooting/not_blocking" }, | ||
| { from: "/u/troubleshooting/usecases", to: "/u/getting_started/usecases" }, |
Comment on lines
+109
to
+111
| These alerts don't block anyone. The submission was accepted, but an [experimental signal](/docs/appsec/bot_detection/signals#experimental-and-scoring-signals) fired. Experimental signals have a weight of 0 while CrowdSec evaluates them. A `detect-experimental-*` prefix in `score_reasons` marks them. | ||
|
|
||
| If one of them proves reliable on your traffic, you can [give it a weight](/docs/appsec/bot_detection/customization#give-an-experimental-signal-a-weight) without waiting for CrowdSec to promote it. |
|
This pull request is automatically being deployed by Amplify Hosting (learn more). |
blotus
approved these changes
Nov 13, 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
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.
Pages to review
issue_*,capi_403)