docs(crowdfunding): improve in-app documentation with Fin structure and FAQ (LFXV2-2532)#1037
Merged
Conversation
…ements (LFXV2-2532) Signed-off-by: Efren Lim <elim@linuxfoundation.org>
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (5)
✅ Files skipped from review due to trivial changes (3)
🚧 Files skipped from review as they are similar to previous changes (2)
WalkthroughAdds a Crowdfunding FAQ page, updates crowdfunding navigation and guidance pages, and registers a crowdfunding topic visual in the docs UI. ChangesCrowdfunding docs and UI topic visual
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR improves the Crowdfunding end-user documentation to better align with Fin/Intercom article structure, adds a standalone Crowdfunding FAQ, and ensures the Docs landing “topic card” has a dedicated Crowdfunding visual.
Changes:
- Added “Before you begin” / “After completing” sections to key Crowdfunding procedural articles and improved intros for Fin surfacing.
- Added a new Crowdfunding FAQ page and linked it from the Crowdfunding docs landing page.
- Added a
crowdfundingentry to the docs topic-card visuals map (icon + container styling).
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/user/crowdfunding/view-initiatives/index.md | Adds “Before you begin” and an “After completing” outcome section. |
| docs/user/crowdfunding/view-donations/index.md | Adds “Before you begin” and an “After completing” outcome section. |
| docs/user/crowdfunding/manage-recurring-donations/index.md | Adds a more explicit intro + “Before you begin” prerequisites. |
| docs/user/crowdfunding/manage-payment-methods/index.md | Adds “Before you begin” prerequisites and explicit “After completing” outcomes for add/delete flows. |
| docs/user/crowdfunding/manage-initiatives/index.md | Reworks the intro for Fin surfacing and adds “Before you begin” prerequisites. |
| docs/user/crowdfunding/index.md | Updates last_updated and adds a Related link to the new FAQ. |
| docs/user/crowdfunding/faq/index.md | New standalone FAQ article covering common initiative/donation questions. |
| apps/lfx-one/src/app/modules/docs/components/docs-topic-card/docs-topic-card.component.ts | Adds Crowdfunding visuals (icon + container classes) for the docs landing grid. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: Efren Lim <elim@linuxfoundation.org>
Contributor
Author
Review Feedback AddressedCommit: a8efb58 Changes Made
Threads Resolved5 of 5 unresolved threads addressed in this iteration. |
MRashad26
approved these changes
Jun 30, 2026
Comment on lines
28
to
45
| @@ -32,7 +39,9 @@ The new card appears in your payment methods list and can be used for future don | |||
| 4. Select **Delete** next to the card you want to remove. | |||
| 5. Confirm the deletion. | |||
|
|
|||
| The card is removed from your account. | |||
| ## After completing (delete) | |||
|
|
|||
| The card is removed from your account immediately. Any active recurring donations linked to that card will fail on their next billing cycle — cancel them before removing the card if you want to stop future charges cleanly. | |||
|
|
|||
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.
Summary
docs/user/crowdfunding/faq/index.md— standalone FAQ article (7 questions) covering initiative status, fund types, archiving donors, cancelling subscriptions, failed charges, and refunds; crowdfunding was the only docs section missing a top-level FAQBefore you beginandAfter completingsections to all procedural articles (view-initiatives,view-donations,manage-initiatives,manage-recurring-donations,manage-payment-methods) per Fin/Intercom best-practice structureAfter completingsections introduced during drafting — removed frommanage-initiatives(was before the steps) andmanage-recurring-donations(was between unrelated action sections); inline confirmation text already covered both casesmanage-initiativesintro to be Fin-surfaceable: now states the article covers edit, archive, and activate rather than starting with a navigation instructionmanage-recurring-donationsintro so Fin can surface the article without relying on the titleLF SSOjargon withLinux Foundation accountacross all Before you begin sections (Fin/Intercom Pillar 8: defined terms)index.mdRelated sectionscrowdfundingentry totopicVisualsindocs-topic-card.component.ts: iconfa-solid fa-box-dollar(matches My Initiatives sidebar entry) withbg-blue-500 text-whitestyle (matches Surveys section)Notes
Screenshots are required by LFXV2-2532 but are not part of this PR — they need manual capture from the production UI at
app.lfx.dev/crowdfundingand will be handled separately. Thelfx-intercomskill'sfin-best-practices.mddoes not itself mandate screenshots; the requirement is ticket-specific.