[docs]: clarify CostService usage and improve metered services discoverability#1287
[docs]: clarify CostService usage and improve metered services discoverability#1287KernelDeimos merged 1 commit intoHeyPuter:mainfrom
Conversation
|
I just noticed another problem - not with this PR, but an aspect the way we do documentation in general. You added a README.md file to the module. That makes sense - we should have that there. We should have that there because it's what people will expect if they're browsing the source via GitHub. However, the way we generate the wiki from markdown files in source ( The README.md should also be more general, but since this PR focuses on documenting cost it makes sense to create the new file with a focus on that for the moment. This will need to be updated later. I'll make issues tomorrow addressing these concerns. This PR is an overall improvement despite these concerns so I'm going to merge it. |
|
@KernelDeimos Thanks for merging! Feel free to assign me the new issue when it's created. Happy to help. |
What does this PR do?
This PR improves and clarifies the documentation around Metered Services and CostService, which are key to Puter's open-source usage-based billing system.
Included in this PR:
src/backend/doc/features/metered-services.mdputerai/README.md(intro section) to direct users to the metered services docsrc/backend/README.mdto guide developers toward backend documentationThese changes ensure contributors can easily find and understand how Puter handles usage billing through
CostService.Fixes #1282
Type of Change
How Should This Be Tested?
puterai/README.mdis visible and points correctlysrc/backend/README.mdand verify the reference to metered services doc is includedmetered-services.mdfor clarity, accuracy, and structureChecklist