ndk
ndk copied to clipboard
Improving Documentation: WIP
Clean up documentation
Full PR + progress available at https://github.com/nostr-dev-kit/ndk/pull/344 Preview URL https://ndkdocs.asknostr.site/
Some notes:
- Items with ✅ in sidebar are mostly done
- Items with ❌ in sidebar are mostly done, unless they have things highlighted below
- Items with ⛔ in sidebar have docs, but need to be linked+cleaned up
Todo List
- [x] Move vitepress to root and use rewrites to clean up paths
- [x] Upgrade vitepress
- [x] Introduction/Essential pages
- [x] Make sure changelogs can be found
- [x] Fix snippets.
- [x] Fundamentals
- [x] Events
- [ ] Signers WIP
- [ ] Add QR code / Nostrconnect:// docs remote signer docs
- [x] Publishing
- [x] Connecting
- [ ] Explain/Cleanup Outbox Docs
- [ ] Wallets
- [ ] Zaps
- [ ] ...
- [x] Link to snippets on key pages
- [ ] Try to find (or remove) API reference link
- [ ] Remove warnings (homepage and main intro) about Docs WIP
- [ ] Remove ✅ ❌ ⛔ icons
Changes made that need double check
- core/tsconfig -> added paths. This makes the snippets in core/docs/snippets have biome/linting
- upgrade bun 1.3.0 and node to +22.