feat/docs caravan health privacy#195
Conversation
|
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
There was a problem hiding this comment.
I like having this documentation in jsdocs. What's the motivation for adding this file as well? I don't mind it but we don't have this anywhere else and my biggest concern is that it will be hard to maintain. Ideally we just have more jsodcs closer to the code like you've added and then we can start generating these docs automatically.
There was a problem hiding this comment.
The motivation for adding this file was to provide a structured overview of these metrics in one place, making it easier to reference their definitions, calculations, and expected ranges. However, I understand the concern about maintainability. I’m happy to keep everything in JSDoc instead and work towards generating the docs automatically. Let me know if you'd like me to remove this file and focus on enhancing the inline documentation instead.
Signed-off-by: AvhiMaz <avhimazumder5@outlook.com>
AvhiMaz
force-pushed
the
feat/docs-caravan-health-privacy
branch
from
bf7eae7 to
66557cc
Compare
Signed-off-by: AvhiMaz <avhimazumder5@outlook.com>
|
@bucko13 please. have a look I've made suggested changes, Thank you! |
| - UTXO Fragmentation (1 input, more than 2 standard outputs) | ||
| - Consolidation (more than 1 input, 1 output) | ||
| - CoinJoin or Mixing (more than 1 input, more than 1 output) | ||
| */ |
There was a problem hiding this comment.
i still think it's worth keeping these descriptions as they are pretty useful. Once we have doc generation this can all be put in a single document (stripped of the code part for readability).
Signed-off-by: AvhiMaz <avhimazumder5@outlook.com>
| "prettier": "^3.1.1", | ||
| "turbo": "^2.0.3" | ||
| "turbo": "^2.0.3", | ||
| "typedoc": "^0.28.1" |
There was a problem hiding this comment.
I don't think we need to add this yet until we're actually using it in CI. We can do that separately.
|
I'm not really sure what the point of this PR is. It looks like some very basic cleanup and now adding a package that's not even being used yet. If you wanted to experiment with generating documentation that we can build and hopefully host with CI I'd be open to work on that (especially something more at the top monorepo level). |
|
@bucko13 closing the pr, let me focus on other one, will be seeing it, implement it correctly and will raise a pr again. thank you. |
2 participants
No description provided.