Skip to content

docs: add runnable examples and trust verification page#25

Open
TDamiao wants to merge 1 commit intomainfrom
docs/issues-5-and-24
Open

docs: add runnable examples and trust verification page#25
TDamiao wants to merge 1 commit intomainfrom
docs/issues-5-and-24

Conversation

@TDamiao
Copy link
Owner

@TDamiao TDamiao commented Feb 27, 2026

Summary

  • add runnable example entrypoints in examples/*.mjs
  • add examples/README.md with run commands and expected output notes
  • add external-reference example (rsi vs technicalindicators) for trustable example validation
  • add docs/trust.md with CI/release/compat verification guidance
  • link examples and trust documentation from README
  • add npm scripts for single example runs and aggregate smoke run (example:all)

Validation

  • npm.cmd run example:all (PASS)
    • RSI signal table rendered
    • batch vs streaming VWAP parity printed
    • funding metrics output printed
    • RSI compat check vs external lib returned PASS

Closes #5
Closes #24

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.

Add documentation trust page with verification signals Add contributor-ready real-world examples

1 participant