docs/revamp-docs #451
Merged
docs/revamp-docs #451
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Fix version placeholders: Replace [VERSION] with 0.5.0 across all docs - Fix relay URLs: Update to working relay (wss://relay.damus.io) - Fix broken references: Correct commit_instructions.md path in CONTRIBUTING.md - Add TROUBLESHOOTING.md: Comprehensive guide for common issues - Installation, connection, authentication, publishing, subscriptions - Encryption/decryption, performance issues - Debug logging and getting help - Add MIGRATION.md: Guide for upgrading from 0.4.0 to 0.5.0 - BOM migration details - Breaking changes and solutions - Common issues and verification steps - Expand extending-events.md: Complete working example - Poll event implementation with custom tags - Factory pattern examples - Testing guidelines and checklist - Add api-examples.md: Document NostrApiExamples.java - 13+ use cases with detailed explanations - Metadata, text notes, DMs, reactions, channels - Running instructions and variations - Update docs/README.md: Add new guides to index - Update main README.md: Highlight NostrApiExamples 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
Replace all relay.damus.io references with relay.398ja.xyz throughout documentation to use the project's preferred relay. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
Remove duplicate content that is better covered in dedicated guides: - Custom events → covered in howto/custom-events.md and explanation/extending-events.md - Text note events → covered in howto/use-nostr-java-api.md and howto/api-examples.md - NostrSpringWebSocketClient → covered in howto/streaming-subscriptions.md - Filters → covered in howto/api-examples.md - TagRegistry → extensively covered in explanation/extending-events.md Replace with links to appropriate guides and add contributing section. Keep CODEBASE_OVERVIEW.md focused on architecture, module layout, building, and testing. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
Update version from 0.5.0 to 0.5.1 in: - pom.xml (root project version) - All documentation files (GETTING_STARTED.md, MIGRATION.md, TROUBLESHOOTING.md, etc.) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
Comprehensive PR document detailing all documentation improvements, new guides added, fixes applied, and version bump to 0.5.1. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
- Added coding principles including Clean Code, Clean Architecture, and design patterns. - Updated documentation generation practices to align with the Diátaxis framework. - Clarified testing and pull request submission guidelines for better compliance. These changes aim to improve code quality and documentation consistency across the project.
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting
Comment on lines
76
to
78
| <properties> | ||
| <nostr-java.version>0.4.0</nostr-java.version> | ||
| <nostr-java.version>0.5.0</nostr-java.version> | ||
| <java.version>21</java.version> |
There was a problem hiding this comment.
The root POM now declares <version>0.5.1</version>, but the shared property remains at 0.5.0 and each module POM still inherits the parent as 0.5.0. This means submodules will continue to publish 0.5.0 artifacts while the aggregator and documentation claim 0.5.1, producing inconsistent coordinates and a broken BOM for consumers. Update the property and child <parent> versions to 0.5.1 so all modules are released under the same version.
Useful? React with 👍 / 👎.
Owner
Author
There was a problem hiding this comment.
@codex address this comment. Add the now removed nostr java version property, and set its value properly
There was a problem hiding this comment.
Summary
- Reintroduced the shared
nostr-java.versionproperty at0.5.1in the root POM to keep published coordinates consistent with the documented release. pom.xmlL60-L89 - Updated every module POM to inherit parent version
0.5.1, ensuring all artifacts are built and released with the new version. nostr-java-api/pom.xmlL1-L9 nostr-java-base/pom.xmlL1-L9 nostr-java-client/pom.xmlL1-L9 nostr-java-crypto/pom.xmlL1-L9 nostr-java-encryption/pom.xmlL1-L9 nostr-java-event/pom.xmlL1-L9 nostr-java-examples/pom.xmlL1-L9 nostr-java-id/pom.xmlL1-L9 nostr-java-util/pom.xmlL1-L9
Testing
⚠️ mvn -q verify(fails because thexyz.tcheeric:nostr-java-bom:1.1.0import POM is unavailable in Maven Central in this environment)
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Documentation Improvements and Version Bump to 0.5.1
Summary
This PR comprehensively revamps the nostr-java documentation, fixing critical issues, adding missing guides, and improving the overall developer experience. The documentation now provides complete coverage with working examples, troubleshooting guidance, and migration instructions.
Related issue: N/A (proactive documentation improvement)
What changed?
Documentation Quality Improvements
Fixed Critical Issues
[VERSION]placeholders with actual version0.5.1wss://relay.398ja.xyzNew Documentation Added (~2,300 lines)
docs/TROUBLESHOOTING.md(606 lines) - Comprehensive troubleshooting for installation, connection, authentication, performance issuesdocs/MIGRATION.md(381 lines) - Complete migration guide for 0.4.0 → 0.5.1 with BOM migration detailsdocs/howto/api-examples.md(720 lines) - Detailed walkthrough of all 13+ examples from NostrApiExamples.javaSignificantly Expanded Existing Docs
docs/explanation/extending-events.md- Expanded from 28 to 597 lines with complete Poll event implementation exampleDocumentation Structure Improvements
docs/README.mdwith better organization and new guidesCODEBASE_OVERVIEW.md(kept focused on architecture)Version Bump
Review Focus
Start here for review:
docs/TROUBLESHOOTING.md- Is the troubleshooting coverage comprehensive?docs/MIGRATION.md- Are migration instructions clear for 0.4.0 → 0.5.1?docs/howto/api-examples.md- Do the 13+ example walkthroughs make sense?docs/explanation/extending-events.md- Is the Poll event example clear and complete?Key files modified:
BREAKING
No breaking changes. This is a documentation-only improvement with version bump to 0.5.1.
The version bump reflects the substantial documentation improvements:
Detailed Changes
1. Fixed Version Placeholders (High Priority)
Files affected:
docs/GETTING_STARTED.md- Maven/Gradle dependency versionsdocs/howto/use-nostr-java-api.md- API usage examples0.5.1with note to check releases page2. Fixed Relay URLs (High Priority)
Files affected:
docs/howto/use-nostr-java-api.mddocs/howto/custom-events.mddocs/howto/streaming-subscriptions.mddocs/reference/nostr-java-api.mddocs/CODEBASE_OVERVIEW.mddocs/TROUBLESHOOTING.mddocs/MIGRATION.mddocs/explanation/extending-events.mddocs/howto/api-examples.mdAll relay URLs updated from
wss://relay.damus.iotowss://relay.398ja.xyz3. New: TROUBLESHOOTING.md (606 lines)
Comprehensive troubleshooting guide covering:
4. New: MIGRATION.md (381 lines)
Migration guide for 0.4.0 → 0.5.1:
5. New: api-examples.md (720 lines)
Complete documentation for NostrApiExamples.java:
6. Expanded: extending-events.md (28 → 597 lines)
Complete guide for extending nostr-java:
7. Cleaned Up: CODEBASE_OVERVIEW.md
Removed 65 lines of redundant examples:
8. Updated Documentation Index
docs/README.md improvements:
README.md improvements:
Benefits
For New Users
For Existing Users
For Contributors
Testing & Verification
Documentation Quality
Content Accuracy
Structure
Checklist
Commits Summary
643539c4- docs: Revamp docs, add streaming subscriptions guide, and add navigation linksb3a8b6d6- docs: comprehensive documentation improvements and fixes61fb3ab0- docs: update relay URLs to use 398ja relay5bfeb088- docs: remove redundant examples from CODEBASE_OVERVIEW.md11a268bd- chore: bump version to 0.5.1Impact
Files Changed: 394 files
Lines Changed
Documentation Coverage
Migration Notes
This PR updates the version to 0.5.1. Users migrating from 0.4.0 should:
docs/MIGRATION.mdfor complete migration guidedocs/TROUBLESHOOTING.mdif issues ariseThe BOM migration from 0.5.0 is already complete. Version 0.5.1 reflects these documentation improvements.
Ready for review! Please focus on the new troubleshooting, migration, and API examples documentation for completeness and clarity.
🤖 Generated with Claude Code
Co-Authored-By: Claude [email protected]