-
Notifications
You must be signed in to change notification settings - Fork 80
docs: improve package descriptions and standardize README formatting #754
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
Conversation
- Add clear description of logger package's purpose and functionality - Improve WASM package description and formatting - Enhance nacl package description with its role in the ecosystem - Clarify lit-node-client-nodejs package purpose and benefits Co-Authored-By: anson@litprotocol.com <anson@litprotocol.com>
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
⚙️ Control Options:
|
|
…ples Co-Authored-By: anson@litprotocol.com <anson@litprotocol.com>
Co-Authored-By: anson@litprotocol.com <anson@litprotocol.com>
Co-Authored-By: anson@litprotocol.com <anson@litprotocol.com>
- Add comprehensive package descriptions - Standardize README structure across packages - Add installation and quick start sections - Include key features and core functionality - Fix formatting issues from linter - Update root README with core systems overview Co-Authored-By: anson@litprotocol.com <anson@litprotocol.com>
- Remove outdated sections (react demo, package deletion, graph dependencies) - Enhance documentation structure and readability - Improve section headings and descriptions - Add detailed tables for environment variables - Restructure error handling and troubleshooting guides Co-Authored-By: anson@litprotocol.com <anson@litprotocol.com>
Co-Authored-By: anson@litprotocol.com <anson@litprotocol.com>
README.md
Outdated
|
||
 | ||
- Cryptographic key management (PKP - Public Key Protocol) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Cryptographic key management (PKP - Public Key Protocol) | |
- Cryptographic key management (PKP - Programable Key Pair) |
Co-Authored-By: anson@litprotocol.com <anson@litprotocol.com>
Co-Authored-By: anson@litprotocol.com <anson@litprotocol.com>
Co-authored-by: Federico Amura <federicoamura@gmail.com> Signed-off-by: Anson <ansonox@gmail.com>
✅ Fixed: Added a meaningful second step to the Quick Start section about building packages with |
Co-Authored-By: anson@litprotocol.com <anson@litprotocol.com>
✅ Fixed: Added release PR creation steps before version bump in the Publishing New Versions section, including:
|
✅ The Error Handling section has been reorganized with improved clarity:
|
All comments have been addressed in PR #754:
The changes can be reviewed at: #754 Note: The CLA check is still pending for devin-ai-integration[bot], but all code-related checks have passed. |
Documentation Improvements for js-sdk
Overview
Comprehensive documentation update improving clarity, organization, and accuracy across the SDK.
Changes
Root README.md Updates:
Package Documentation:
Testing
Link to Devin run: https://app.devin.ai/sessions/bd1d9020bb874e5ca34d18144904f23b