Add FAQ section with troubleshooting checklists#3404
Merged
Conversation
Two new guides distilled from recurring support-forum threads and GitHub issues: follow requests stuck on pending, and comments from the Fediverse not showing up (captcha/antispam plugins and friends).
There was a problem hiding this comment.
Pull request overview
This PR adds a new troubleshooting-oriented FAQ documentation section and links to it from existing user-facing docs/readmes, to make the most common support resolutions easier to find.
Changes:
- Add
docs/faq/with two checklist-style troubleshooting guides (pending follows; missing federated comments). - Cross-link the new FAQ section from
docs/readme.md,docs/how-to/readme.md, and the pluginreadme.txt. - Add a patch-level changelogger entry announcing the new FAQ guides.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| readme.txt | Updates the “How do I solve…” FAQ pointer to include the new docs FAQ section and examples. |
| docs/readme.md | Adds a top-level “FAQ” section linking to the new troubleshooting docs. |
| docs/how-to/readme.md | Cross-links to the FAQ for “something broken” troubleshooting before configuration guides. |
| docs/faq/readme.md | Introduces the FAQ landing page and table of contents. |
| docs/faq/pending-follow-requests.md | New troubleshooting checklist for diagnosing pending follow requests (inbound vs outbound). |
| docs/faq/missing-comments.md | New troubleshooting checklist for missing federated comments (queues, captcha/antispam, inbox blocking, semantics). |
| .github/changelog/add-troubleshooting-faq | Changelogger entry for the added FAQ guides. |
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.
Proposed changes:
Other information:
Testing instructions: