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

Enhance Developer Experience with Improved Documentation and SDK Features #131

Open
oxatik opened this issue Nov 18, 2024 · 0 comments
Open
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@oxatik
Copy link

oxatik commented Nov 18, 2024

Feature Description
As Nillion continues to grow and attract more developers interested in building blind applications, we need to focus on improving our developer experience. This issue aims to enhance our documentation and SDK features to better support our growing community of builders.

Why is this feature important?

Updated Developer Documentation:

  • Review and update existing documentation to ensure it's comprehensive and easy to understand
  • Create new tutorials and guides for common use cases,
  • Improve code examples and provide more real-world scenarios

Nillion SDK Enhancements:

  • Implement left shift (<<) and right shift with truncation (>>) operations for integers
  • Add probabilistic truncation feature (trunc_pr)
  • Introduce private equality comparison for secret integers

How do developers use the feature?

Network Improvements:

  • Increase storage capacity for secretBlobs from 100KB to 1MB
  • Fix MIR bug impacting program execution and refactor core state machines

Python Client Updates:

  • Replace deprecated user_id() and party_id() methods with attributes
  • Ensure consistency between Python and JavaScript clients

Community Engagement:

  • Improve onboarding process for new developers
  • Create a more interactive developer community forum
  • Develop a system for showcasing community projects and achievements

Performance Optimization:

  • Implement efficient number precision management techniques
  • Enhance fixed-point operations for machine learning applications

Bug Reporting and Tracking:

  • Improve bug reporting process with clear guidelines and templates
  • Develop a system for tracking and prioritizing reported issues

Testing:

  • Thoroughly test all updated features and documentation
  • Perform load testing to ensure improved performance
  • Gather user feedback through surveys and community discussions

Resources Needed:

  • Developer team members for SDK development and documentation
  • QA engineers for thorough testing
  • Community managers for engaging with developers and gathering feedback

Success Metrics:

  • Reduction in reported bugs related to documentation and SDK usage
  • Increase in community engagement metrics (forum posts, project submissions)
  • Positive feedback on improved developer experience
  • Reduction in time taken for common development tasks

Usage or commands

Additional context
Implementation Steps:

1.Conduct a thorough review of existing documentation and identify areas for improvement

2.Update SDK features based on community feedback and evolving needs

3.Implement network improvements and optimize performance

4.Refactor Python client to replace deprecated methods with attributes

5.Develop strategies for better community engagement and project showcase

6.Implement efficient number precision management techniques

7.Set up a robust bug reporting and tracking system

@oxatik oxatik added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant