Skip to content

Commit b9dd32b

Browse files
chriscrosstalkclaude
authored andcommitted
docs: update documentation for recent features and hardware page
- Add hardware guide link (projectnomad.us/hardware) to README, FAQ, and About page - Add Apache 2.0 license section to README and About page - Add Early Access Channel FAQ and Getting Started mention - Add GPU passthrough warning troubleshooting entry to FAQ - Add Knowledge Base document deletion to FAQ and Getting Started Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 58b106f commit b9dd32b

File tree

4 files changed

+24
-1
lines changed

4 files changed

+24
-1
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,8 @@ To run LLM's and other included AI tools:
8282
- OS: Debian-based (Ubuntu recommended)
8383
- Stable internet connection (required during install only)
8484

85+
**For detailed build recommendations at three price points ($200–$800+), see the [Hardware Guide](https://www.projectnomad.us/hardware).**
86+
8587
Again, Project N.O.M.A.D. itself is quite lightweight - it's the tools and resources you choose to install with N.O.M.A.D. that will determine the specs required for your unique deployment
8688

8789
## About Internet Usage & Privacy
@@ -136,6 +138,10 @@ Use the format `- **Area**: Description` to stay consistent with existing entrie
136138
- **Discord:** [Join the Community](https://discord.com/invite/crosstalksolutions) - Get help, share your builds, and connect with other NOMAD users
137139
- **Benchmark Leaderboard:** [benchmark.projectnomad.us](https://benchmark.projectnomad.us) - See how your hardware stacks up against other NOMAD builds
138140

141+
## License
142+
143+
Project N.O.M.A.D. is licensed under the [Apache License 2.0](LICENSE).
144+
139145
## Helper Scripts
140146
Once installed, Project N.O.M.A.D. has a few helper scripts should you ever need to troubleshoot issues or perform maintenance that can't be done through the Command Center. All of these scripts are found in Project N.O.M.A.D.'s install directory, `/opt/project-nomad`
141147

admin/docs/about.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,16 @@
22

33
Project N.O.M.A.D. (Node for Offline Media, Archives, and Data; "Nomad" for short) is a project started in 2025 by Chris Sherwood of [Crosstalk Solutions, LLC](https://crosstalksolutions.com). The goal of the project is not to create just another utility for storing offline resources, but rather to allow users to run their own ultimate "survival computer".
44

5-
While many similar offline survival computers are designed to be run on bare-minimum, lightweight hardware, Project N.O.M.A.D. is quite the opposite. To install and run the available AI tools, we highly encourage the use of a beefy, GPU-backed device to make the most of your install.
5+
While many similar offline survival computers are designed to be run on bare-minimum, lightweight hardware, Project N.O.M.A.D. is quite the opposite. To install and run the available AI tools, we highly encourage the use of a beefy, GPU-backed device to make the most of your install. See the [Hardware Guide](https://www.projectnomad.us/hardware) for detailed build recommendations at three price points.
66

77
Since its initial release, NOMAD has grown to include built-in AI chat with a Knowledge Base for document-aware responses, a System Benchmark with a community leaderboard, curated content collections with tiered options, and an Easy Setup Wizard to get new users up and running quickly.
88

9+
Project N.O.M.A.D. is open source, released under the [Apache License 2.0](https://github.com/Crosstalk-Solutions/project-nomad/blob/main/LICENSE).
10+
911
## Links
1012

1113
- **Website:** [www.projectnomad.us](https://www.projectnomad.us)
14+
- **Hardware Guide:** [www.projectnomad.us/hardware](https://www.projectnomad.us/hardware)
1215
- **Discord:** [Join the Community](https://discord.com/invite/crosstalksolutions)
1316
- **GitHub:** [Crosstalk-Solutions/project-nomad](https://github.com/Crosstalk-Solutions/project-nomad)
1417
- **Benchmark Leaderboard:** [benchmark.projectnomad.us](https://benchmark.projectnomad.us)

admin/docs/faq.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ N.O.M.A.D. is designed for capable hardware, especially if you want to use the A
1818
- SSD storage (size depends on content — 500GB minimum, 2TB+ recommended)
1919
- NVIDIA or AMD GPU recommended for faster AI responses
2020

21+
**For detailed build recommendations at three price points ($200–$800+), see the [Hardware Guide](https://www.projectnomad.us/hardware).**
22+
2123
### How much storage do I need?
2224
It depends on what you download:
2325
- Full Wikipedia: ~95GB
@@ -79,13 +81,18 @@ The AI must be installed first — enable it during Easy Setup or install it fro
7981
3. Documents are processed and indexed automatically
8082
4. Ask questions in AI Chat — the AI will reference your uploaded documents when relevant
8183

84+
You can also remove documents from the Knowledge Base when they're no longer needed.
85+
8286
NOMAD documentation is automatically added to the Knowledge Base when the AI Assistant is installed.
8387

8488
### What is the System Benchmark?
8589
The System Benchmark tests your hardware performance and generates a NOMAD Score — a weighted composite of CPU, memory, disk, and AI performance. You can create a Builder Tag (a NOMAD-themed identity like "Tactical-Llama-1234") and share your results with the [community leaderboard](https://benchmark.projectnomad.us).
8690

8791
Go to **[System Benchmark →](/settings/benchmark)** to run one.
8892

93+
### What is the Early Access Channel?
94+
The Early Access Channel lets you opt in to receive release candidate builds with the latest features and improvements before they hit stable releases. You can enable or disable it from **Settings → Check for Updates**. Early access builds may contain bugs — if you prefer stability, stay on the stable channel.
95+
8996
---
9097

9198
## Troubleshooting
@@ -137,6 +144,10 @@ When you add or swap a GPU, N.O.M.A.D. needs to reconfigure the AI container to
137144

138145
Force Reinstall recreates the AI container with GPU support enabled. Without this step, the AI continues to run on CPU only.
139146

147+
### I see a "GPU passthrough not working" warning
148+
149+
N.O.M.A.D. checks whether your GPU is actually accessible inside the AI container. If a GPU is detected on the host but isn't working inside the container, you'll see a warning banner on the System Information and AI Settings pages. Click the **"Fix: Reinstall AI Assistant"** button to recreate the container with proper GPU access. This preserves your downloaded AI models.
150+
140151
### AI Chat not available
141152

142153
The AI Chat page requires the AI Assistant to be installed first:

admin/docs/getting-started.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,7 @@ The Knowledge Base lets you upload documents so the AI can reference them when a
103103
2. Upload your documents (PDFs, text files, etc.)
104104
3. Documents are processed and indexed automatically
105105
4. Ask questions in AI Chat — the AI will reference your uploaded documents when relevant
106+
5. Remove documents you no longer need — they'll be deleted from the index and local storage
106107

107108
**Use cases:**
108109
- Upload emergency plans for quick reference during a crisis
@@ -183,6 +184,8 @@ While you have internet, periodically check for updates:
183184

184185
Content updates (Wikipedia, maps, etc.) can be managed separately from software updates.
185186

187+
**Early Access Channel:** Want the latest features before they hit stable? Enable the Early Access Channel from the Check for Updates page to receive release candidate builds. You can switch back to stable anytime.
188+
186189
### Monitoring System Health
187190

188191
Check on your server anytime:

0 commit comments

Comments
 (0)