Skip to content

docs(crowdfunding): add user documentation for crowdfunding section#961

Open
emlimlf wants to merge 4 commits into
mainfrom
feat/crowdfunding-documentation
Open

docs(crowdfunding): add user documentation for crowdfunding section#961
emlimlf wants to merge 4 commits into
mainfrom
feat/crowdfunding-documentation

Conversation

@emlimlf

@emlimlf emlimlf commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add 8 user-facing documentation pages for the new Crowdfunding section covering My Initiatives (topic landing, view initiatives, manage initiatives) and My Donations (topic landing, view donations, manage payment methods, manage recurring donations)
  • Register crowdfunding in DOCS_TAXONOMY_ORDER in both the shared constants package and the build-manifest script
  • Regenerate search-index.json to include the new crowdfunding articles

Copilot AI review requested due to automatic review settings June 16, 2026 12:40
@emlimlf emlimlf requested a review from a team as a code owner June 16, 2026 12:40
@coderabbitai

coderabbitai Bot commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 685f0546-fa9d-4e8e-8735-14804f66115d

📥 Commits

Reviewing files that changed from the base of the PR and between 5091571 and 3c05acd.

📒 Files selected for processing (3)
  • docs/user/crowdfunding/manage-initiatives/index.md
  • docs/user/crowdfunding/manage-payment-methods/index.md
  • docs/user/crowdfunding/view-initiatives/index.md
✅ Files skipped from review due to trivial changes (3)
  • docs/user/crowdfunding/manage-initiatives/index.md
  • docs/user/crowdfunding/manage-payment-methods/index.md
  • docs/user/crowdfunding/view-initiatives/index.md

Walkthrough

Adds a new crowdfunding topic slug to DOCS_TAXONOMY_ORDER in both the shared constants file and the build-manifest script, and introduces eight new markdown documentation pages under docs/user/crowdfunding/ covering the crowdfunding section index, My Initiatives, My Donations, and their respective sub-pages.

Changes

Crowdfunding Documentation and Taxonomy Registration

Layer / File(s) Summary
Crowdfunding topic registered in taxonomy order
packages/shared/src/constants/docs.constant.ts, apps/lfx-one/scripts/lib/build-manifest.mjs
'crowdfunding' slug appended to DOCS_TAXONOMY_ORDER in both the shared constants and the build-manifest script, inserting the new topic into the canonical docs display order.
Crowdfunding index and top-level section pages
docs/user/crowdfunding/index.md, docs/user/crowdfunding/my-initiatives/index.md, docs/user/crowdfunding/my-donations/index.md
Landing page and both top-level section indexes added with frontmatter metadata, capability overviews, navigation routes, sub-page links, and related cross-links.
View and Manage Initiatives sub-pages
docs/user/crowdfunding/view-initiatives/index.md, docs/user/crowdfunding/manage-initiatives/index.md
View Initiatives describes the stats bar, status filter pills, and card list. Manage Initiatives covers the detail page layout (Overview/Financials tabs), edit/archive/activate steps, and the More menu status restriction.
View Donations, Manage Recurring Donations, and Manage Payment Methods sub-pages
docs/user/crowdfunding/view-donations/index.md, docs/user/crowdfunding/manage-recurring-donations/index.md, docs/user/crowdfunding/manage-payment-methods/index.md
View Donations describes the stats bar, recurring donations list, and donation history table. Manage Recurring Donations covers detail viewing and the cancellation confirmation flow. Manage Payment Methods provides add and delete steps with a note about effects on active recurring donations.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • linuxfoundation/lfx-self-serve#947: Modifies the same DOCS_TAXONOMY_ORDER constant in apps/lfx-one/scripts/lib/build-manifest.mjs and packages/shared/src/constants/docs.constant.ts, directly relating to the taxonomy positioning changes in this PR.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and accurately summarizes the main change: adding user documentation for the crowdfunding section. It is concise, specific, and directly related to the primary objective of this pull request.
Description check ✅ Passed The description is well-related to the changeset, providing a clear summary of the eight documentation pages added, the configuration updates to DOCS_TAXONOMY_ORDER, and the search index regeneration. It accurately reflects the actual changes made.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/crowdfunding-documentation

Comment @coderabbitai help to get the list of available commands and usage tips.

@emlimlf emlimlf force-pushed the feat/crowdfunding-documentation branch from 4044019 to d913cd3 Compare June 16, 2026 12:42

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/user/crowdfunding/manage-initiatives/index.md`:
- Around line 31-42: The ordered list is breaking because the table following
list item 3 is not properly indented as a nested continuation. To fix the MD029
error, indent the entire table (all rows from the header row starting with "Tab"
through the "Funding" row) by 4 spaces so that it is recognized as content
belonging to list item 3 rather than breaking the list structure. This will
ensure list item 4 ("Save your changes.") is correctly recognized as the fourth
item in the ordered sequence.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 08279820-3cbd-467c-a0b2-64d2e5817bac

📥 Commits

Reviewing files that changed from the base of the PR and between 2ae1c6d and 4044019.

📒 Files selected for processing (11)
  • apps/lfx-one/public/assets/docs/search-index.json
  • apps/lfx-one/scripts/lib/build-manifest.mjs
  • docs/user/crowdfunding/index.md
  • docs/user/crowdfunding/manage-initiatives/index.md
  • docs/user/crowdfunding/manage-payment-methods/index.md
  • docs/user/crowdfunding/manage-recurring-donations/index.md
  • docs/user/crowdfunding/my-donations/index.md
  • docs/user/crowdfunding/my-initiatives/index.md
  • docs/user/crowdfunding/view-donations/index.md
  • docs/user/crowdfunding/view-initiatives/index.md
  • packages/shared/src/constants/docs.constant.ts

Comment thread docs/user/crowdfunding/manage-initiatives/index.md Outdated

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/user/crowdfunding/index.md`:
- Line 32: In the Initiative definition on line 32 where it describes "a
fundraising campaign for an open source project," update the terminology to use
the hyphenated form "open-source project" to follow standard technical writing
conventions for compound adjectives.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 00de6517-1fa6-4109-9e17-e6c193e60d7d

📥 Commits

Reviewing files that changed from the base of the PR and between 4044019 and 1c85137.

📒 Files selected for processing (11)
  • apps/lfx-one/public/assets/docs/search-index.json
  • apps/lfx-one/scripts/lib/build-manifest.mjs
  • docs/user/crowdfunding/index.md
  • docs/user/crowdfunding/manage-initiatives/index.md
  • docs/user/crowdfunding/manage-payment-methods/index.md
  • docs/user/crowdfunding/manage-recurring-donations/index.md
  • docs/user/crowdfunding/my-donations/index.md
  • docs/user/crowdfunding/my-initiatives/index.md
  • docs/user/crowdfunding/view-donations/index.md
  • docs/user/crowdfunding/view-initiatives/index.md
  • packages/shared/src/constants/docs.constant.ts
✅ Files skipped from review due to trivial changes (7)
  • docs/user/crowdfunding/my-donations/index.md
  • packages/shared/src/constants/docs.constant.ts
  • docs/user/crowdfunding/view-donations/index.md
  • docs/user/crowdfunding/view-initiatives/index.md
  • docs/user/crowdfunding/manage-recurring-donations/index.md
  • docs/user/crowdfunding/my-initiatives/index.md
  • docs/user/crowdfunding/manage-initiatives/index.md
🚧 Files skipped from review as they are similar to previous changes (2)
  • docs/user/crowdfunding/manage-payment-methods/index.md
  • apps/lfx-one/scripts/lib/build-manifest.mjs

Comment thread docs/user/crowdfunding/index.md Outdated
@emlimlf

emlimlf commented Jun 16, 2026

Copy link
Copy Markdown
Contributor Author

Review Feedback Addressed

Commit: 3a22fd4

Changes Made

  • docs/user/crowdfunding/index.md: hyphenated "open-source project" (per coderabbitai[bot])

Threads Resolved

1 of 1 unresolved threads addressed in this iteration.

@MRashad26 MRashad26 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Automated review + code-standards-enforcer audit (report-only). 4 commits; 3 feature/fix commits signed off by Efren Lim, 1 merge commit (unsigned — normal). No Claude or Cursor co-author trailers. ✅

🔒 Secrets / critical-constants check

Documentation and constants only. No credentials, endpoints, or auth changes. ✅

Overview

Adds 8 Markdown user-docs pages for the new Crowdfunding section (crowdfunding/index, my-initiatives, my-donations, view-initiatives, view-donations, manage-initiatives, manage-payment-methods, manage-recurring-donations). Registers 'crowdfunding' in DOCS_TAXONOMY_ORDER in both packages/shared/src/constants/docs.constant.ts (Angular runtime) and apps/lfx-one/scripts/lib/build-manifest.mjs (Node.js build script, which can't import TS packages). Regenerates search-index.json to include the new articles.

Correctness — verified ✅

  • DOCS_TAXONOMY_ORDER updated in both files in sync, consistent with the existing pattern. ✅
  • All 8 docs have consistent YAML frontmatter (title, description, audience, product_area, tags, last_generated, last_updated, intercom_collection). ✅
  • All cross-links use relative paths (../view-initiatives/, ../../transactions/) — correct for the flat docs directory structure. ✅
  • view-donations/index.md correctly describes the "Donation kind (Monthly or One-time)" column, consistent with the kind field added in recent backend work. ✅
  • The numbered-list fix (commit 2) is applied — Archive and Activate step lists each start from 1. independently. ✅
  • manage-initiatives/index.md correctly notes the More menu is only available for Published or Archived initiatives (not Pending/Submitted). ✅

Code Standards Audit (~/LFX/code-enforcer-agent.md)

🔴 Critical: none.

🟡 Warning: none.

🔵 Info:

  • last_generated / last_updated frontmatter fields are set to today (2026-06-16) in all 8 docs. These will silently go stale as the app evolves without corresponding doc PRs. Pre-existing pattern across the docs section — not a violation.

✅ Correctly followed: 'crowdfunding' added to both DOCS_TAXONOMY_ORDER arrays in sync, no source-code changes (constants only), signed-off commits, no test plan in PR body.

Verdict: PASS

@clkrueger

Copy link
Copy Markdown

@mlehotskylf @MRashad26 @emlimlf I came across this in slack and took a look. It doesn't appear that the Intercom skill was used when creating this documentation. Great to see the Fast Follow on the documentation! @WillsonHG

Docs look solid structurally — a few Fin optimization gaps before we merge.

Before these land in Intercom as knowledge articles, they need a pass through our lfx-intercom skill to make sure Fin can resolve conversations from them effectively.

1. Relative links will break in Intercom.
All 8 files use relative paths (../manage-initiatives/). These need to be absolute knowledge article URLs before publishing.

2. manage-payment-methods/index.md — vague consequence on card delete.
"Any active recurring donations that use this card may need to be updated" doesn't tell the user what actually happens. Fin will give an incomplete answer. Suggest: "If a recurring donation is using this card, it will fail on the next billing cycle — update the payment method on that subscription before removing the card."

3. Fund types aren't defined in the sub-pages.
view-initiatives and manage-initiatives reference "General Fund, Security Audit, Mentorship, or Event" without explanation. These are defined in the top-level index, but Fin often surfaces sub-pages directly — the definitions need to live where the terms are used, or link explicitly to the index.

The top-level crowdfunding/index.md is the best of the set — the "Who this applies to" and "Key concepts" sections are exactly right. The sub-pages should follow that pattern.

emlimlf added 3 commits June 17, 2026 10:13
Signed-off-by: Efren Lim <elim@linuxfoundation.org>
Signed-off-by: Efren Lim <elim@linuxfoundation.org>
Signed-off-by: Efren Lim <elim@linuxfoundation.org>
@emlimlf emlimlf force-pushed the feat/crowdfunding-documentation branch from 3a22fd4 to 5091571 Compare June 17, 2026 02:13
…on impact

Signed-off-by: Efren Lim <elim@linuxfoundation.org>
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.

3 participants