Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Oct 29, 2025

Users lack explicit platform compatibility information, forcing them to infer requirements from scattered sources. This adds a comprehensive "Supported Platforms" section to README.md.

Platform Documentation Added

  • Operating Systems: Ubuntu 22.04+ (Linux), macOS 13.0+ (Ventura and later). Windows explicitly noted as unsupported.

  • Architectures: x86_64 and aarch64/ARM64 fully supported, including Apple Silicon and AWS Graviton processors.

  • Build Requirements:

    • Rust 1.89.0 minimum (from Cargo.toml)
    • Go 1.24+ for FFI bindings (from ffi/go.mod)
    • System dependencies: protoc, cargo, make
  • CI Test Coverage: Documents which platforms are tested in main CI vs. FFI static library builds:

    • Main CI: ubuntu-latest (x86_64), macos-latest (ARM64)
    • FFI builds: ubuntu-22.04-arm, macos-13 (x86_64), macos-latest (ARM64)
  • Cloud Platforms:

    • AWS instance recommendations by architecture (Graviton ARM64 vs Intel/AMD x86_64)
    • References to deployment automation in benchmark/bootstrap/aws-launch.sh
    • GCP/Azure general compatibility noted
  • Platform-Specific Considerations:

    • Linux: io_uring usage, memlock limits, NVMe recommendations
    • macOS: Docker VirtioFS limitations, CARGO_TARGET_DIR requirements for containers
    • Performance characteristics across platforms

Section placed after Architecture Diagram, before Terminology. Cross-references added to avoid confusion about Intel macOS support (FFI-only testing).

Original prompt

This section details on the original issue you should resolve

<issue_title>Document supported platforms and compatibility requirements</issue_title>
<issue_description>### Problem
There is no explicit list of supported operating systems, architectures, or compatibility notes for dependencies. Users may attempt to build or run Firewood in unsupported environments.

Proposed Solution

Add a "Supported Platforms" section to the top-level README.md with clear compatibility information.

Content to Include

  • Supported operating systems (Linux, macOS, Windows)
  • Supported architectures (x86_64, ARM64, etc.)
  • Minimum Rust version required
  • Required system dependencies and versions
  • Tested configurations
  • Known platform-specific issues or limitations
  • Container/Docker support
  • Cloud platform compatibility (AWS, GCP, Azure)
  • Performance characteristics on different platforms

Current State

  • Build dependencies listed in README.md
  • No explicit platform compatibility documentation
  • Platform requirements must be inferred

References

  • Build section in README.md
  • Cargo.toml - Rust version and dependencies
  • benchmark/bootstrap/aws-launch.sh - AWS setup
  • Docker documentation in README.docker.md</issue_description>

Comments on the Issue (you are @copilot in this section)


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI changed the title [WIP] Document supported platforms and compatibility requirements Document supported platforms and compatibility requirements Oct 29, 2025
Copilot AI requested a review from rkuris October 29, 2025 22:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document supported platforms and compatibility requirements

2 participants