docs(crowdfunding): add user documentation for crowdfunding section#961
docs(crowdfunding): add user documentation for crowdfunding section#961emlimlf wants to merge 4 commits into
Conversation
|
Note Reviews pausedIt 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 Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
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 (3)
✅ Files skipped from review due to trivial changes (3)
WalkthroughAdds a new ChangesCrowdfunding Documentation and Taxonomy Registration
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
4044019 to
d913cd3
Compare
There was a problem hiding this comment.
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
📒 Files selected for processing (11)
apps/lfx-one/public/assets/docs/search-index.jsonapps/lfx-one/scripts/lib/build-manifest.mjsdocs/user/crowdfunding/index.mddocs/user/crowdfunding/manage-initiatives/index.mddocs/user/crowdfunding/manage-payment-methods/index.mddocs/user/crowdfunding/manage-recurring-donations/index.mddocs/user/crowdfunding/my-donations/index.mddocs/user/crowdfunding/my-initiatives/index.mddocs/user/crowdfunding/view-donations/index.mddocs/user/crowdfunding/view-initiatives/index.mdpackages/shared/src/constants/docs.constant.ts
There was a problem hiding this comment.
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
📒 Files selected for processing (11)
apps/lfx-one/public/assets/docs/search-index.jsonapps/lfx-one/scripts/lib/build-manifest.mjsdocs/user/crowdfunding/index.mddocs/user/crowdfunding/manage-initiatives/index.mddocs/user/crowdfunding/manage-payment-methods/index.mddocs/user/crowdfunding/manage-recurring-donations/index.mddocs/user/crowdfunding/my-donations/index.mddocs/user/crowdfunding/my-initiatives/index.mddocs/user/crowdfunding/view-donations/index.mddocs/user/crowdfunding/view-initiatives/index.mdpackages/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
Review Feedback AddressedCommit: 3a22fd4 Changes Made
Threads Resolved1 of 1 unresolved threads addressed in this iteration. |
MRashad26
left a comment
There was a problem hiding this comment.
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_ORDERupdated 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.mdcorrectly describes the "Donation kind (Monthly or One-time)" column, consistent with thekindfield 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.mdcorrectly 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_updatedfrontmatter 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
|
@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. 2. 3. Fund types aren't defined in the sub-pages.
|
Signed-off-by: Efren Lim <elim@linuxfoundation.org>
Signed-off-by: Efren Lim <elim@linuxfoundation.org>
Signed-off-by: Efren Lim <elim@linuxfoundation.org>
3a22fd4 to
5091571
Compare
…on impact Signed-off-by: Efren Lim <elim@linuxfoundation.org>
Summary
crowdfundinginDOCS_TAXONOMY_ORDERin both the shared constants package and the build-manifest scriptsearch-index.jsonto include the new crowdfunding articles