Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
148 commits
Select commit Hold shift + click to select a range
77059ed
Merge pull request #1 from nostr-dev-kit/master
digitalbase Oct 10, 2025
33442f0
Remove docs cookbook
digitalbase Oct 11, 2025
4d29698
Merge branch 'nostr-dev-kit:master' into master
digitalbase Oct 11, 2025
4424765
Revert Doc removal
digitalbase Oct 11, 2025
d771a40
Move docs from ndk-core to core
digitalbase Oct 11, 2025
6c4d7b5
Remove dupe commands
digitalbase Oct 11, 2025
15e1025
Add gitignore for vitepress cache
digitalbase Oct 11, 2025
9b5498f
Move vitepress to root folder to be able to access rewritten docs
digitalbase Oct 11, 2025
056575a
Delete/remove package from docs folder
digitalbase Oct 11, 2025
9887505
Update index to correct paths
digitalbase Oct 11, 2025
025d1eb
Empty two broken markdown files
digitalbase Oct 11, 2025
ca7b32a
Correct docs:build command
digitalbase Oct 11, 2025
eadc6dc
Also commit lockb
digitalbase Oct 11, 2025
4b84677
Update lockfile
digitalbase Oct 11, 2025
d49bbef
Switch to bun 1.3.0
digitalbase Oct 11, 2025
949f258
Update bun lockfile
digitalbase Oct 11, 2025
f69ff69
Update bun package manager
digitalbase Oct 11, 2025
71b8346
Bump node version
digitalbase Oct 11, 2025
1516272
Remove /ndk subpath
digitalbase Oct 11, 2025
30b1876
Move readmes to /advanced folders + fixed blossom docs
digitalbase Oct 11, 2025
63ff0c5
Fixed blossom readmes
digitalbase Oct 11, 2025
a0eb8fe
Mobile docs
digitalbase Oct 11, 2025
06546d6
Migrate session docs
digitalbase Oct 11, 2025
09b2102
Fixed cache adapters
digitalbase Oct 11, 2025
32c3e10
Moved cache adapters to advanced
digitalbase Oct 11, 2025
94a88ad
Wallet docs
digitalbase Oct 11, 2025
1ebe06c
Rename getting started
digitalbase Oct 11, 2025
fe513d2
Fix wallet docs
digitalbase Oct 11, 2025
edae9e0
Reorganise Docs
digitalbase Oct 12, 2025
dd58ecf
Improve introduction
digitalbase Oct 12, 2025
6e0d58c
Update usage and debugging docs
digitalbase Oct 13, 2025
7f0bf80
Enable more levels on righgt side 'on this page' menu
digitalbase Oct 13, 2025
0dc4ad9
Remove connecting section from getting started
digitalbase Oct 13, 2025
128f435
Linking to outbox model
digitalbase Oct 13, 2025
6718d38
Minor improvement to TIP
digitalbase Oct 13, 2025
b10a8bd
Update WebLN docs
digitalbase Oct 13, 2025
b69ecf7
Update docs
digitalbase Oct 13, 2025
9287079
Refer to Nip057 docs
digitalbase Oct 13, 2025
6a3fa40
Update NWC and WebLN docs
digitalbase Oct 14, 2025
2311f38
Update nutsack docs
digitalbase Oct 14, 2025
a193022
Merge branch 'nostr-dev-kit:master' into master
digitalbase Oct 14, 2025
851d694
Merge remote-tracking branch 'origin/master' into feature/docs-route-…
digitalbase Oct 14, 2025
b694aaa
Revert mobile changelog
digitalbase Oct 14, 2025
cd9749b
Update bun lock
digitalbase Oct 14, 2025
72aabc0
Remove unused docs-styles
digitalbase Oct 14, 2025
8577440
Remove license (will be done globally)
digitalbase Oct 14, 2025
099859d
Added changelog index page
digitalbase Oct 14, 2025
d32faec
Update changelog
digitalbase Oct 14, 2025
fd511a0
Made all links absolute + removed rewrites
digitalbase Oct 14, 2025
cf043ff
Introduce events, publishing fundamental docs and moved those snippet…
digitalbase Oct 14, 2025
f2cdb5a
More examples
digitalbase Oct 14, 2025
1f1a8b3
Moved snippets from /core file into /docs
digitalbase Oct 14, 2025
e3cd700
Updated tsconfig so examples don't complain over path
digitalbase Oct 14, 2025
5b418b1
Linked snippets to /docs/snippets.md
digitalbase Oct 14, 2025
f1608a5
Fix build
digitalbase Oct 15, 2025
f0c7648
Improve events docs:
digitalbase Oct 15, 2025
a8b6fc1
Fix paths of home/changelog
digitalbase Oct 15, 2025
fbfa114
Update some docs
digitalbase Oct 15, 2025
15586c9
Add .idea to gitignore
digitalbase Oct 15, 2025
b8dabf3
Merge pull request #343 from digitalbase/feature/docs-route-rewrites
digitalbase Oct 15, 2025
e6e0377
Merge remote-tracking branch 'origin/master' into feature/improve-docs
digitalbase Oct 15, 2025
2fc7c5d
Update bun lock (installing from 1.3.0)
digitalbase Oct 15, 2025
3ddde64
Doc build command
digitalbase Oct 15, 2025
6e73900
Add about nostr + contributing guidelines
digitalbase Oct 15, 2025
39f9ca7
Move advanced signing docs into signers.md
digitalbase Oct 15, 2025
da7e4cc
Signing docs
digitalbase Oct 16, 2025
542d72a
Working on docs
digitalbase Oct 22, 2025
b90687a
Merge branch 'master' into feature/improve-docs
digitalbase Oct 22, 2025
8686c29
Remove copied docs from /docs folder
digitalbase Oct 22, 2025
9c14188
Do not show title on first nav link
digitalbase Oct 22, 2025
f43a21b
Allow snippet reuse in different docs sections
digitalbase Oct 22, 2025
cbf12c8
Move more snippets + cleanup
digitalbase Oct 22, 2025
af7e9cb
Added warnings to the docs repo
digitalbase Oct 22, 2025
9417f09
Updating docs in left sidebar
digitalbase Oct 22, 2025
ea438a0
Update TODOS
digitalbase Oct 22, 2025
40f4aae
Work on docs
digitalbase Oct 24, 2025
efb8b30
Merge branch 'master' into feature/improve-docs
digitalbase Nov 20, 2025
b90c8f5
Update doc dependencies
digitalbase Nov 20, 2025
0498cd6
Add quick start to getting started docs
digitalbase Nov 20, 2025
d9c7a2f
Move signer relays to signer docs
digitalbase Nov 20, 2025
f8d279e
Fix guardrails/quick-start snippet
digitalbase Nov 20, 2025
d9cb245
Move usage higher
digitalbase Nov 20, 2025
6fcfe4c
Clean up connecting and nip-19
digitalbase Nov 20, 2025
b4a0f46
Move architecture suggestions to backup doc and remove from getting-s…
digitalbase Nov 20, 2025
efb93c0
Move subscribe docs to fundamentals
digitalbase Nov 20, 2025
443dfd7
Move vitepress config from the root to the docs folder
digitalbase Nov 20, 2025
89f5d10
Clean urls for docs (no .html in the end)
digitalbase Nov 20, 2025
42066d6
Clean up introduction page + break out supported nips + link them
digitalbase Nov 20, 2025
d9d3d4f
Swap links to nostr-nips.com to the github source of truth
digitalbase Nov 20, 2025
c1bab95
Add subscribing to sidebar
digitalbase Nov 20, 2025
798b0ca
Add snippets index files
digitalbase Nov 20, 2025
81f8a90
Move more snippets to snippet folder + fix syntax
digitalbase Nov 20, 2025
fa80704
Fix code snippets indexes + add code snippets to subscribe
digitalbase Nov 20, 2025
4345717
Reorganise fundamentals
digitalbase Nov 21, 2025
8356e5b
Clean up connecting docs
digitalbase Nov 21, 2025
e0a17e8
Remove publishing tutorial doc (already in publishing) but swap out t…
digitalbase Nov 21, 2025
2f02b80
Fold what's left behind (on event publication status) into publishing…
digitalbase Nov 21, 2025
2c62035
Do not relist snippets in docs page but just have a section 'snippets…
digitalbase Nov 21, 2025
c4eb5b7
Move exclusive relays docs + hinted from fundamtentals/subscriptions
digitalbase Nov 23, 2025
15f2ccc
Add snippet
digitalbase Nov 23, 2025
cbbde83
Move testing directory to docs
digitalbase Nov 23, 2025
6aab1e1
Move key signing/encryption to signer doc + snippets
digitalbase Nov 23, 2025
8a3db07
Move nip49 to snippets and embed in signer docs
digitalbase Nov 23, 2025
d33ea66
Add helper fundamental docs + remove outdated fetchprofile example
digitalbase Nov 23, 2025
5201d4a
Move 2.15 announcement RELEASE-NOTES to changelog
digitalbase Nov 23, 2025
2266cbb
Moved old migration guide to docs/migration
digitalbase Nov 23, 2025
d0dbf0d
Remove old usage backup markdown file
digitalbase Nov 23, 2025
7f7e1b7
Move archiecture suggestions to advanced
digitalbase Nov 23, 2025
bc46066
Add NIP-49 and NIP-19 helper documentation to fundamtentals/helpers
digitalbase Nov 23, 2025
40cc20e
Remove LLM implementation plan for SIG-SAMPLING
digitalbase Nov 23, 2025
d1fc7b6
Remove old outbox.md file (documented in connecting outbox)
digitalbase Nov 23, 2025
d2b82aa
Move all examples (from different places) to snippets/examples
digitalbase Nov 23, 2025
da860c6
Delete dupe internal doc (subscription internals)
digitalbase Nov 23, 2025
104e5f7
Link to advanced subscription internal doc
digitalbase Nov 23, 2025
25e22f6
Delete dupe docs
digitalbase Nov 23, 2025
746b095
Move every doc related file that's related to vitepress to /docs folder
digitalbase Nov 23, 2025
ef63ebb
Remove prettierignore (using biome)
digitalbase Nov 23, 2025
f763cca
Link specific migration guides from changelogs
digitalbase Nov 23, 2025
60b5d3c
Fix paths in vitepress docs after moving stuff outside of core
digitalbase Nov 23, 2025
71e077e
Delete dupe zap docs
digitalbase Nov 23, 2025
ee4af15
Merge tutorial/auth into connecting.md (+fix import paths)
digitalbase Nov 23, 2025
30b7994
Move subscription management to advanced docs
digitalbase Nov 23, 2025
cecebe8
Move more docs to advanced so /tutorial can be removed
digitalbase Nov 23, 2025
0d9e0f8
Move signer-persistence + refer to it from signer doc
digitalbase Nov 23, 2025
ab467c4
Remove some fundamentals
digitalbase Nov 25, 2025
c14b668
Fix build
digitalbase Nov 25, 2025
a4268c5
Build to ./docs/dist folder
digitalbase Nov 25, 2025
e5fbe96
Rename config
digitalbase Nov 25, 2025
ca33521
Update gitignore
digitalbase Nov 25, 2025
6d69521
Add gitignore for docs dir
digitalbase Nov 25, 2025
d5513b6
Add public directory
digitalbase Nov 25, 2025
6abef9f
Fix build errors by moving file path to code snippet
digitalbase Nov 25, 2025
0eb624e
Add build directory to gitignore
digitalbase Nov 25, 2025
9bbfd96
Add package.json file to snippets so scripts can be verified with lat…
digitalbase Dec 9, 2025
1ea8952
Update doc to check on Pablo's revert
digitalbase Dec 9, 2025
c8ce873
Update gitignore
digitalbase Dec 9, 2025
20e1438
Fix snippets
digitalbase Dec 9, 2025
a1507f8
Add wallet to package.json and fix zap snippet
digitalbase Dec 9, 2025
3fd664a
Merge remote-tracking branch 'origin/master' into feature/improve-docs
digitalbase Dec 9, 2025
266f6b6
Update docs from upstream changes (4a7b086bd1f67f22a6c29adcf4d6c51b4d…
digitalbase Dec 9, 2025
6ec9a52
Fix doc build commands (revert)
digitalbase Dec 9, 2025
097a46f
Add tsconfig to allow top level awaits
digitalbase Dec 9, 2025
f903be2
Improve sessions docs
digitalbase Dec 9, 2025
64ea5a3
Move guardrail examples
digitalbase Dec 9, 2025
faedbb7
Move nip19 examples to snippets directory
digitalbase Dec 9, 2025
e7079f9
Replace nip19 by moving essential to helpers and snippets
digitalbase Dec 9, 2025
cf554e4
Add code snippets to helpers
digitalbase Dec 9, 2025
d75ece0
Remove duplicate helper documentation
digitalbase Dec 9, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 1 addition & 18 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
**/node_modules
temp
.idea
**/build
**/dist
**/coverage
Expand All @@ -21,32 +22,15 @@ package-lock.json
*.tgz
.DS_Store
.turbo
.idea
bun.lockb
_local_
.svelte-kit/
.pnpm-store
docs/.vitepress/cache
docs/.vitepress/dist
.ngit
**/.repomix-output.txt
cursor-tools.config.json
coverage

# Generated docs directories
/docs/getting-started/
/docs/internals/
/docs/migration/
/docs/tutorial/
/docs/api-examples.md
/docs/index.md
/docs/snippets/
/docs/cache/
/docs/mobile/
/docs/wallet/
/docs/wrappers/
/docs/hooks/
**/docs/api/
cache-sqlite/example/cache.db

# TENEX project files
Expand All @@ -60,4 +44,3 @@ svelte/examples/basic-feed/public/
.test-sessions.json
**/baseline-timing.ts
**/current-timing.ts
.playwright-mcp
2 changes: 1 addition & 1 deletion biome.json
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
}
},
"files": {
"includes": ["**/*.{js,ts,jsx,tsx,json}"],
"includes": ["**/*.{js,ts,jsx,tsx,json}", "!/core/docs/snippets"],
"ignoreUnknown": true
},
"vcs": {
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
4 changes: 0 additions & 4 deletions cache-dexie/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,3 @@ const ndk = new NDK({cacheAdapter: dexieAdapter, ...other config options});
```

🚨 Because Dexie only exists client-side, this cache adapter will not work in pure node.js environments. You'll need to make sure that you're using the right cache adapter in the right place (e.g. Redis on the backend, Dexie on the frontend).

# License

MIT
File renamed without changes.
7 changes: 0 additions & 7 deletions core/.prettierignore

This file was deleted.

29 changes: 29 additions & 0 deletions core/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -465,6 +465,35 @@

## 2.15.0

I'm happy to announce the release of NDK 2.15. This is a very significant release that's been in the works for quite a
while. The main focus of this release has been in reducing the amount of footguns in NDK. Yes, mainly thinking about
making the vibecoding scene a lot more enjoyable: LLMs are great at churning out code at insane speed. Not so much at
debugging, optimizations, performant code. So this new release of NDK focuses a lot on making sure that the most obvious
solution is the right solution.

ndk-hooks

I spun out a new package called ndk-hooks. Someone else had built (and abandoned) an ndk-react package, and LLMs
constantly got confused using it and produced terrible code. ndk-hooks is an offshoot of ndk-mobile, and, if you're
vibecoding Next.js apps like most people are doing, ndk-hooks provides you with all the building blocks to make sure
your agents don't lose their minds.

ndk-core

A lot has changed under the hood to make space for performant access points, particularly synchronous access points.

Worthy mentions:

- The whole codebase has been migrated to use modern tooling: bun and vitest.
- Very useful test helpers, until now, writing tests on clients was a pain, NDK now ships with @nostr-dev-kit/ndk/test
which provides a `MockRelay` that provides access to very useful testing utilities.
- Race condition bugs are now gone, no more dreaded "Not enough relays received this event" when publishing before
connecting to relays.

ndk-sqlite-wasm-cache-adapter

A new cache adapter leveraging SQLite WASM is now available. This should be the preferred option to

### Minor Changes

- Implement dynamic subscription relay refresh for outbox model
Expand Down
7 changes: 0 additions & 7 deletions core/OUTBOX.md

This file was deleted.

21 changes: 0 additions & 21 deletions core/RELEASE-NOTES.md

This file was deleted.

Loading