Starworld Documentation
This directory contains all project documentation organized by topic.
Documentation Index
Getting Started
- ../README.md - Main project README with quick start guide
- DEVELOPER_GUIDE.md - Developer quick reference with commands and tips
- DIRECTORY_STRUCTURE.md - Project organization and file layout
Project Information
- CHANGELOG.md - Version history and changes
- CI_SETUP_SUMMARY.md - Continuous integration setup and workflow
Implementation Guides
- OVERTE_ASSIGNMENT_CLIENT_TASK.md - Overte protocol implementation details
- OVERTE_AUTH.md - OAuth 2.0 authentication implementation guide
- ENTITY_RENDERING_ENHANCEMENTS.md - Entity rendering system
- MODELCACHE_IMPLEMENTATION.md - Asset download and caching
Planning Documents
- CODE_CLEANUP_PLAN.md - Code organization and cleanup plans
Quick Links
For New Developers
- Start with ../README.md for project overview
- Read DEVELOPER_GUIDE.md for build/run commands
- Check CHANGELOG.md to understand recent changes
For Contributors
- Review CI_SETUP_SUMMARY.md for testing workflow
- Read relevant implementation guides for the area you're working on
- Follow conventions described in CODE_CLEANUP_PLAN.md
For Protocol Work
- Study OVERTE_ASSIGNMENT_CLIENT_TASK.md for protocol details
- Review OVERTE_AUTH.md if working on authentication
- Check Overte source code references in each document
For Rendering Work
- Read ENTITY_RENDERING_ENHANCEMENTS.md for rendering pipeline
- Review MODELCACHE_IMPLEMENTATION.md for asset loading
- Check the Rust bridge code in
../bridge/src/lib.rs
External Resources
StardustXR
- Website: https://stardustxr.org
- Documentation: https://stardustxr.org/docs
- GitHub: https://github.com/StardustXR
Overte
- Website: https://overte.org
- Documentation: https://docs.overte.org
- GitHub: https://github.com/overte-org/overte
- Discord: https://discord.gg/overte
Contributing to Documentation
When adding or updating documentation:
- Keep documents focused on a single topic
- Use clear, descriptive filenames
- Include code examples where helpful
- Update this README.md index
- Link between related documents
- Keep the main README.md up to date with links
Documentation Style
- Use Markdown format (
.md) - Include a clear title and overview
- Use code blocks with language tags
- Add links to external resources
- Keep line length reasonable for readability
- Use relative links for internal references