Skip to content

Improving Documentation: WIP #344

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.

Sign up for GitHub

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

Jump to bottom
Draft
digitalbase wants to merge 148 commits into
base: master
Choose a base branch
from
Draft

Improving Documentation: WIP #344

digitalbase wants to merge 148 commits into from

Conversation

@digitalbase
Copy link
Collaborator

@digitalbase digitalbase commented Oct 15, 2025 •
edited
Loading

Clean up documentation

Full PR + progress available at #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

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.

digitalbase and others added 30 commits October 10, 2025 11:19
@digitalbase
Merge pull request #1 from nostr-dev-kit/master
77059ed 
Merge upstream
@digitalbase
Remove docs cookbook
33442f0
@digitalbase
Merge branch 'nostr-dev-kit:master' into master
4d29698
@digitalbase
Revert Doc removal
4424765
@digitalbase
Move docs from ndk-core to core
d771a40
@digitalbase
Remove dupe commands
6c4d7b5
@digitalbase
Add gitignore for vitepress cache
15e1025
@digitalbase
Move vitepress to root folder to be able to access rewritten docs
9b5498f
@digitalbase
Delete/remove package from docs folder
056575a
@digitalbase
Update index to correct paths
9887505
@digitalbase
Empty two broken markdown files
025d1eb
@digitalbase
Correct docs:build command
ca7b32a
@digitalbase
Also commit lockb
eadc6dc
@digitalbase
Update lockfile
4b84677
@digitalbase
Switch to bun 1.3.0
d49bbef
@digitalbase
Update bun lockfile
949f258
@digitalbase
Update bun package manager
f69ff69
@digitalbase
Bump node version
71b8346
@digitalbase
Remove /ndk subpath
1516272
@digitalbase
Move readmes to /advanced folders + fixed blossom docs
30b1876
@digitalbase
Fixed blossom readmes
63ff0c5
@digitalbase
Mobile docs
a0eb8fe
@digitalbase
Migrate session docs
06546d6
@digitalbase
Fixed cache adapters
09b2102
@digitalbase
Moved cache adapters to advanced
32c3e10
@digitalbase
Wallet docs
94a88ad
@digitalbase
Rename getting started
1ebe06c
@digitalbase
Fix wallet docs
fe513d2
@digitalbase
Reorganise Docs
edae9e0
@digitalbase
Improve introduction
dd58ecf
@digitalbase
Merge tutorial/auth into connecting.md (+fix import paths)
ee4af15
@digitalbase
Move subscription management to advanced docs
30b7994
@digitalbase
Move more docs to advanced so /tutorial can be removed
cecebe8
@digitalbase
Move signer-persistence + refer to it from signer doc
0d9e0f8
@digitalbase
Remove some fundamentals
ab467c4
@digitalbase
Fix build
c14b668
@digitalbase
Build to ./docs/dist folder
a4268c5
@digitalbase
Rename config
e5fbe96
@digitalbase
Update gitignore
ca33521
@digitalbase
Add gitignore for docs dir
6d69521
@digitalbase
Add public directory
d5513b6
@digitalbase
Fix build errors by moving file path to code snippet
6abef9f
@digitalbase
Add build directory to gitignore
0eb624e
@digitalbase
Add package.json file to snippets so scripts can be verified with lat…
9bbfd96 
…est NDK
@digitalbase
Update doc to check on Pablo's revert
1ea8952
@digitalbase
Update gitignore
c8ce873
@digitalbase
Fix snippets
20e1438
@digitalbase
Add wallet to package.json and fix zap snippet
a1507f8
@digitalbase
Merge remote-tracking branch 'origin/master' into feature/improve-docs
3fd664a 
# Conflicts:
#	bun.lock
#	core/docs/advanced/ai-guardrails.md
#	core/docs/snippets/examples/ai-guardrails-example.ts
#	core/docs/snippets/examples/replaceable-event-guardrail.ts
#	core/snippets/subscription/exclusive-relay.md
#	core/tsconfig.json
#	docs/.vitepress/config.mts
#	docs/api-examples.md
#	docs/wot/index.md
#	package.json
#	sessions/tsconfig.json
#	svelte/examples/sessions-demo/CLAUDE.md
#	wot/docs/index.md
@digitalbase
Update docs from upstream changes (4a7b086)
266f6b6
@digitalbase
Fix doc build commands (revert)
6ec9a52
@digitalbase
Add tsconfig to allow top level awaits
097a46f
@digitalbase
Improve sessions docs
f903be2
@digitalbase
Move guardrail examples
64ea5a3
@digitalbase
Move nip19 examples to snippets directory
faedbb7
@digitalbase
Replace nip19 by moving essential to helpers and snippets
e7079f9
@digitalbase
Add code snippets to helpers
cf554e4
@digitalbase
Remove duplicate helper documentation
d75ece0
@digitalbase digitalbase mentioned this pull request Dec 13, 2025
Closed
@digitalbase digitalbase self-assigned this Dec 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@digitalbase digitalbase

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@digitalbase