Documentation
Comprehensive guides, references, and tutorials for working with ProteanOS.
Documentation Overview
This documentation hub provides resources for users and developers working with ProteanOS. Whether you're installing the system for the first time, porting to new hardware, or developing applications, you'll find relevant guides and reference materials here.
The documentation is organized into several sections based on common tasks and workflows. Each section provides progressive detail, starting with high-level concepts and moving into specific procedures and examples.
Getting Started
Installation Guide
Set up your development environment and install ProteanOS components.
Download
Get the SDK, development tools, and documentation packages.
Platform Documentation
Platform documentation covers hardware-specific topics including board support, device drivers, and system configuration. These guides are essential when working with specific hardware targets.
Porting Guide
Learn how to port ProteanOS to new hardware platforms.
Specifications
Technical specifications and standards documentation.
Development Resources
Development documentation covers the tools, workflows, and conventions used in ProteanOS development. This includes the ProKit development environment, packaging system, and contribution guidelines.
Development Hub
Tools, workflows, and resources for ProteanOS development.
ProKit
The ProteanOS Development Kit and build tools.
Reference Materials
Reference documentation provides detailed information on specific topics, including API references, configuration options, and troubleshooting guides. Use these resources when you need precise technical details.
- Source Package Format 2.0 — Package format specification and examples
- Packaging Requirements — What's needed for ProteanOS packages
- Archive Layout — Structure of package archives
- Git Repositories — Source code organization and access
Community Resources
Beyond the documentation, the ProteanOS community provides additional support channels and resources:
- Mailing Lists — Discussion forums for users and developers
- FAQ — Answers to common questions
- Changelog — History of documentation and project updates
Documentation Conventions
Throughout the documentation, you'll encounter consistent formatting conventions that help identify different types of information:
Monospace textindicates commands, filenames, code, or configuration values.- Bold text highlights important terms or key concepts.
- Blockquotes contain notes, tips, or warnings that deserve special attention.
- Code blocks with headers show the context (shell commands, configuration files, etc.).
Navigation Tip
Use the breadcrumb navigation at the top of each page to move between sections. The site search and main navigation also provide quick access to all major documentation areas.
Documentation FAQ
Where should I start with the documentation?
If you're new to ProteanOS, start with the installation guide to set up your development environment. Then explore the areas relevant to your goals—porting for hardware work, or development for software contributions.
How current is the documentation?
Each page includes a "last updated" timestamp. We maintain documentation alongside code changes, but some specialized topics may lag behind. Report outdated content through the mailing lists.
Can I contribute to the documentation?
Yes, documentation contributions are welcome. The documentation source is maintained alongside the project source code. See the development section for contribution workflows.
Is the documentation available offline?
Documentation archives are available for download in the downloads section. These packages contain the same content in a format suitable for offline access.
What if I can't find information on a specific topic?
Check the FAQ pages and mailing list archives. If you still can't find an answer, ask on the appropriate mailing list—others may have encountered the same question.