Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: enhance documentation clarity and examples in Nada-by-example #158

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

CreeptoGengar
Copy link

This PR improves the documentation clarity in the Nada-by-example section by adding more detailed explanations and examples.

Changes made:

  1. addition.md:

    • Added comprehensive description of basic addition operations
    • Clarified the fundamental arithmetic capabilities
  2. arg-max.md:

    • Improved technical terminology (changed "Argmax" to "arg max")
    • Added concrete example with sequence [3, 1, 4, 1, 5]
    • Enhanced explanation of index-based results
  3. cardio-risk.md:

    • Added detailed explanation of privacy-preserving features
    • Included risk score scale (0-100)
    • Added interpretation guidelines for risk levels
    • Specified examples of health metrics used
  4. comparison.md:

    • Added general introduction to comparison operators
    • Clarified return values (boolean true/false)
    • Added specific descriptions for each operator (<, <=, >, >=)
    • Highlighted secure computation aspect

These changes make the documentation more accessible to new users while maintaining technical accuracy.

Copy link

vercel bot commented Dec 27, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
nillion-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 27, 2024 6:52pm

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.

1 participant