Skip to content

Docs/onboarding updates#1134

Closed
alltheseas wants to merge 4 commits into
nostrdevkit:masterfrom
alltheseas:docs/onboarding-updates
Closed

Docs/onboarding updates#1134
alltheseas wants to merge 4 commits into
nostrdevkit:masterfrom
alltheseas:docs/onboarding-updates

Conversation

@alltheseas

Copy link
Copy Markdown
Contributor

Summary

  • add repo-level getting-started instructions (toolchain, just
    targets, examples, offline docs) plus context for the Supported
    NIPs table
  • flesh out crate-level READMEs (relay pool/builder, keyring,
    gossip engines, RFS) with descriptions, feature notes, and runnable
    examples so integrators know how to use them
  • expand contributor docs with workflow/script guidance and spell
    out the private vulnerability reporting process

Testing

  • documentation-only changes

@alltheseas

Copy link
Copy Markdown
Contributor Author

@yukibtc I found a painpoint of pretty much all FOSS repos not having comprehensive documentation, as the code is more important. I am not a rust-nostr expert, so I look to your sanity check on this documentation 🙏

@yukibtc

yukibtc commented Nov 13, 2025

Copy link
Copy Markdown
Member

Thanks @alltheseas! I've cherry-picked some of the changes.

Regarding the NIP-09 example: I prefer to put specific examples regarding NIPs or certain SDK features in the book, so that correctness can always be verified by CI during various updates and examples can also be written for bindings.
So I moved your example here: nostrdevkit/book#19

@yukibtc yukibtc closed this Nov 13, 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.

2 participants