docs: Add Scroll system documentation #28
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Explain Scroll concept (OCI artifacts for deployment) - Document scroll.yaml format and all fields - Provide examples for 95+ game servers - Detail command system and procedures - Cover ColdStarter integration - Document plugin system - Include best practices and contribution guidelines - Add troubleshooting and advanced topics
Contributor
Author
|
Contributor
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
docs | 4743d1c | Commit Preview URL Branch Preview URL |
Feb 10 2026, 03:11 PM |
added 7 commits
February 10, 2026 14:11
- Replace Next Steps section with external GitHub links - Fixes broken link errors for files that don't exist yet
- Add prominent section explaining command names are 100% customizable - No required names (start, stop, install are just conventions) - Show multiple examples with custom names (launch, halt, setup, etc.) - Add FAQ clarifying this freedom - Update all command references to emphasize customization
- Remove generic 'built-in dependencies' list - Add comprehensive Nix section explaining why/how it works - Explain isolation, reproducibility, 80k+ package library - Show real-world examples (multi-version Java) - Explain Nix store, caching, and performance benefits - Emphasize Nix as foundational to Druid architecture - Link to nixpkgs search for package discovery
- Replace 'Fork the Repository' with 'Find Examples' linking to scrolls repo - Remove incorrect commands: druid scroll build, druid scroll deploy, druid start - Add correct commands: druid scroll validate, druid serve, druid run <command> - Remove 'Publish to Registry' section (maintainer-only workflow) - Verified against druid-cli source code
- Verified all modes from druid-cli source code - Removed incorrect modes: signal, http, write (don't exist) - Added actual modes: exec, exec-tty, stdin, scroll-switch, rcon, command - Added correct data formats for each mode - Note about plugin-provided modes
- Removed package list from Dependencies subsection - Removed package examples from Available Packages subsection - Keep Nix section generic, just point to nixpkgs search - Users can discover packages themselves at search.nixos.org
- Reduced from 665 to 260 lines - Verified druid scroll validate, druid serve, druid run against CLI source - Verified procedure modes: exec, exec-tty, stdin, scroll-switch, rcon, command - Verified scroll.yaml field names against domain/scroll.go - Removed repetitive examples and fluff - Keep only essential information
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Comprehensive documentation for Druid's Scroll system - OCI artifacts that define application deployment and management.
Content
Key Features Documented
✅ Declarative deployment manifests
✅ OCI-compliant artifact format
✅ Version control and reproducibility
✅ 95 published scrolls (Minecraft, Rust, Hytale, LGSM)
✅ Command and procedure system
✅ Dependency management
✅ Plugin extensibility
✅ Community contribution workflow
Target Audience
Position: docs/scrolls/ (new section)