docs(platform-fees): simplify configuration guide and remove AI-generated content warning#67
Open
docs(platform-fees): simplify configuration guide and remove AI-generated content warning#67
Conversation
…uide
Refactor `api-features/platform-fees.mdx` to document platform-fee configuration clearly and accurately for v2 API consumers.
- remove AI placeholder framing and unsupported/ambiguous wording
- focus page scope on platform fee setup (`feePercentage`, `feeAddress`)
- document validation constraints and required parameter pairing
- correct endpoint usage for fee parameters:
- GET /v2/request/{requestId}/pay
- POST /v2/payouts
- POST /v2/payouts/batch
- add cURL examples with `x-api-key` auth style
- add cross-links to Protocol Fees and Fee Breakdowns
- point users to canonical OpenAPI docs for full schemas
This was referenced Mar 2, 2026
Open
Open
Open
Member
Author
This was referenced Mar 2, 2026
aimensahnoun
changed the title
api-features/platform-fees.mdx to document platform-fee configuration clearly and accurately for v2 API consumers. - remove AI placeholder framing and unsupported/ambiguo
Greptile SummaryThis PR successfully simplifies the platform fees documentation by removing AI-generated content warnings, condensing verbose explanations, and converting JavaScript examples to cURL format for better API reference alignment. Key improvements:
Issues found:
The documentation simplification aligns with the recent pattern seen in other migrated pages ( Confidence Score: 2/5
Important Files Changed
Last reviewed commit: ab88d80 |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
| - **Percentage-Based:** Platform defines `feePercentage` at payment time | ||
| - **Smart Contract Level:** API converts percentage to fixed `feeAmount` for smart contract | ||
| - **Separate Recipient:** Fees sent to specified `feeAddress` | ||
| Use this page for setup and integration patterns. For protocol-level fees charged by Request Network, see [Protocol Fees](/api-features/protocol-fees). |
There was a problem hiding this comment.
broken link: /api-features/protocol-fees doesn't exist in the repository navigation (verified in docs.json)
Comment on lines
+110
to
112
| <Card title="Protocol Fees" href="/api-features/protocol-fees"> | ||
| Understand Request Network protocol-level fees. | ||
| </Card> |
There was a problem hiding this comment.
broken link: "Protocol Fees" card references non-existent page. Remove this card or replace with valid reference
Comment on lines
+19
to
25
| <ParamField query="feePercentage" type="string"> | ||
| Fee percentage to apply at payment time (for example `"2.5"` for 2.5%). | ||
| </ParamField> | ||
|
|
||
| <ParamField body="feeAddress" type="string"> | ||
| Ethereum address to receive the platform fee | ||
| <ParamField query="feeAddress" type="string"> | ||
| Wallet address that receives the platform fee. | ||
| </ParamField> |
There was a problem hiding this comment.
misleading parameter type: these params use query type, but they're body parameters for POST endpoints listed on lines 42-43. Consider using separate ParamField blocks for each endpoint type, or use generic descriptions without specifying query/body
This was referenced Mar 3, 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
1 participant
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.
TL;DR
Rewrote the Platform Fees documentation to be more concise and focused on practical implementation.
What changed?
How to test?
Why make this change?
The original documentation was verbose and contained AI-generated disclaimers that reduced credibility. The new version provides a cleaner, more actionable reference that developers can quickly scan to understand requirements and implement platform fees without unnecessary complexity.