FlashOS Product Guide

Not sure where to begin? Pick a goal from the first table. The rest of this page is the full index for system guides, Flash references, policies, and project records.

Start here

Goal	Page	Covers
Build and boot FlashOS	Getting Started	Host setup, local configuration, image construction, QEMU, login, first checks, and troubleshooting
Understand how Flash fits	Flash and FlashOS	The current shell integration, data and status handling, and the planned Shell/View design
Try the language	Flash by Example	Small executable programs for structured values, external bytes, check, and plan
Learn Flash in depth	Flash Documentation	Tutorials, the Flash 1.0 language reference, scripting, internals, and development
About Me	About Me	Personal background, motivation, working approach, and project principles
Contribute	Contributing	Issues, proposals, safe starter work, verification, documentation standards, and review expectations

Documentation map

The FlashOS README is the front door. From there, the public documentation splits into these paths:

• Main product guide: Product Guide → Getting Started → Flash and FlashOS → Architecture → Development → Public Automation → Verification and Testing → Hardware Compatibility → Roadmap → About Me → Contributing → Upstream References.
• Flash guide: Flash Overview → Flash Documentation → Flash by Example → Language Guide → Scripting Guide → Flash Architecture → Flash Development → CI/CD Contracts.
• Focused Flash references: Flash Changelog, Performance Benchmarks, Flash v1 Exercises, Scheduling Stress, Fuzz Targets, End-to-end Tests, Test Fixtures, Grammar Corpus, and Lexical Corpus.
• Project records and policies: CI/CD Contracts → Changelog → FlashOS v0.2.0 Release Notes → Security Policy → Trademark and Project Identity.
• Compatibility redirects: Documentation, Setup, and Hardware keep older links working.
• Issue routes: Bug Report, Documentation Issue, Hardware Report, and Proposal.
• Retained Redox snapshots: Hardware and Trademark are historical upstream references reached through Upstream References; they do not define FlashOS behavior or policy.

FlashOS system guides

Guide	Scope
Architecture	Current system layers, image profiles, build-to-boot flow, component ownership, and upstream boundaries
Development	Repository workflow, build operations, packages, profiles, generated state, and review preparation
Public Automation	Flash-native programs, reviewed interpreter exceptions, setup boundary, and host tools
Verification and Testing	Source, target, profile, image, QEMU, release, and physical-hardware evidence
Hardware Compatibility	Device-specific results, qualification vocabulary, safe testing, and reporting
Roadmap	Work in progress, likely next steps, later ideas, and non-goals

Flash guides and technical references

• Flash Overview — Component role, v1 contract, implementation, tooling, and entry points.
• Flash by Example — Curated executable examples.
• Language Guide — Frozen Flash 1.0 syntax, values, functions, modules, and pipelines.
• Scripting Guide — Files, arguments, checking, formatting, processes, statuses, errors, and jobs.
• Flash Architecture — Crates, analysis, planning, execution, platform capabilities, and lifecycle.
• Flash Development — Component toolchains, tests, target work, fuzzing, benchmarks, and documentation maintenance.
• Flash Changelog — Component release history.
• Flash Supporting References — Exercises, benchmarks, scheduling stress, fuzzing, and test corpora.
• CI/CD Contracts — Exact local scripts, hosted workflows, classification, artifacts, and failure interpretation.

Policies and project records

• Changelog — FlashOS release history and current unreleased changes.
• FlashOS v0.2.0 Release Notes — Highlights, evaluation boundaries, credentials, qualification scope, and release assets.
• Security Policy — Reporting, evaluation scope, supported-version policy, and pre-alpha limitations.
• Trademark and Project Identity — FlashOS identity and upstream mark boundaries.
• License and Notice — Root licensing, third-party licenses, and attribution.
• Upstream References — Classification and interpretation of retained Redox reference snapshots.

Compatibility paths

Legacy documentation, setup, and hardware files remain as redirects for old links and bookmarks. New links should point here, to Getting Started, or to Hardware Compatibility.