Skip to content

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

Merged
merged 16 commits into from
Jan 15, 2025

Conversation

devin-ai-integration[bot]
Copy link
Contributor

@devin-ai-integration devin-ai-integration bot commented Jan 2, 2025

Documentation Improvements for js-sdk

Overview

Comprehensive documentation update improving clarity, organization, and accuracy across the SDK.

Changes

  1. Root README.md Updates:

    • Remove outdated sections:
      • Create a new react demo app section
      • Deleting a package or app section
      • Interactive graph dependencies section and graph
    • Improve intuitive wording throughout
    • Note: Packages table remains untouched (autogenerated)
  2. Package Documentation:

    • Enhanced all package READMEs with standardized formatting
    • Added clear descriptions for each package's purpose
    • Improved installation and usage instructions
    • Updated code examples and API references

Testing

  • Documentation-only changes
  • All formatting checks passing
  • No code modifications

Link to Devin run: https://app.devin.ai/sessions/bd1d9020bb874e5ca34d18144904f23b

- 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>
Copy link
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add "(aside)" to your comment to have me ignore it.
  • Look at CI failures and help fix them

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@CLAassistant
Copy link

CLAassistant commented Jan 2, 2025

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
2 out of 3 committers have signed the CLA.

✅ Ansonhkg
✅ FedericoAmura
❌ devin-ai-integration[bot]
You have signed the CLA already but the status is still pending? Let us recheck it.

devin-ai-integration bot and others added 4 commits January 2, 2025 19:26
…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>
@devin-ai-integration devin-ai-integration bot changed the title docs: improve package descriptions in READMEs docs: improve package descriptions and standardize README formatting Jan 2, 2025
devin-ai-integration bot and others added 4 commits January 2, 2025 21:38
- 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

![](https://i.ibb.co/2dLyMTW/Screenshot-2022-11-15-at-15-18-46.png)
- Cryptographic key management (PKP - Public Key Protocol)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Cryptographic key management (PKP - Public Key Protocol)
- Cryptographic key management (PKP - Programable Key Pair)

devin-ai-integration bot and others added 3 commits January 6, 2025 14:50
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>
Copy link
Contributor Author

✅ Fixed: Added a meaningful second step to the Quick Start section about building packages with yarn build:dev. The numbered list now provides clear, sequential steps for getting started.

Co-Authored-By: anson@litprotocol.com <anson@litprotocol.com>
Copy link
Contributor Author

✅ Fixed: Added release PR creation steps before version bump in the Publishing New Versions section, including:

  • Branch naming convention (vX.X.X-Publish)
  • Changelog requirement in PR description
  • Release label requirement
  • Example PR reference (Publish version 7.0.4 #753)

Copy link
Contributor Author

✅ The Error Handling section has been reorganized with improved clarity:

  • Added clear overview section
  • Improved code example with detailed comments
  • Structured documentation for creating custom errors
  • Added metadata and context examples

Copy link
Contributor Author

All comments have been addressed in PR #754:

  1. Quick Start section: Added meaningful second step about building packages
  2. Publishing section: Added release PR creation steps with proper formatting
  3. Error Handling section: Improved organization and clarity

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.

@Ansonhkg Ansonhkg merged commit 6fb9791 into master Jan 15, 2025
4 of 5 checks passed
@Ansonhkg Ansonhkg deleted the devin/1735845077-update-readmes branch January 15, 2025 17:42
@Ansonhkg Ansonhkg mentioned this pull request Feb 5, 2025
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.

3 participants