Docs: add macOS instructions to developer getting-started guide #1247

dannywillems · 2025-07-24T13:34:27Z

Add comprehensive macOS support to the developer documentation by:

Creating platform-specific setup scripts for macOS using Homebrew
Splitting installation instructions using tabbed interface for Linux and macOS
Adding macOS CI testing jobs to verify setup scripts work correctly
Renaming CI jobs for clarity (ubuntu, macos, docker-ubuntu, docker-macos)

This enables macOS developers to easily set up their development environment
with proper platform-specific installation commands.

dannywillems · 2025-07-24T14:39:20Z

Removing the -b option as:

ln: illegal option -- b
usage: ln [-s [-F] | -L | -P] [-f | -i] [-hnv] source_file [target_file]
       ln [-s [-F] | -L | -P] [-f | -i] [-hnv] source_file ... target_dir
       link source_file target_file
make: *** [download-circuits] Error 1

Source: OpenMina CI

dannywillems · 2025-07-24T15:16:01Z

Investigating

error: "/Users/runner/.rustup/toolchains/nightly-aarch64-apple-darwin/lib/rustlib/src/rust/library/Cargo.lock" does not exist, unable to build with the standard library, try:
        rustup component add rust-src --toolchain nightly-aarch64-apple-darwin
make: *** [build-wasm] Error 101
Building testing framework...

It seems it is also present for Ubuntu. The error hasn't been caught before.
Fixed in d312f25

Add comprehensive macOS support to the developer documentation by: - Creating platform-specific setup scripts for macOS using Homebrew - Splitting installation instructions using tabbed interface for Linux and macOS - Adding macOS CI testing jobs to verify setup scripts work correctly - Renaming CI jobs for clarity (ubuntu, macos, docker-ubuntu, docker-macos) This enables macOS developers to easily set up their development environment with proper platform-specific installation commands.

It does seem necessary also for this command.

Add taplo-cli (TOML formatter) to the Rust installation script and update developer documentation to explain what tools are installed. This fixes the 'make: taplo: No such file or directory' error when running make format commands. - Added taplo-cli installation to install-rust.sh - Updated getting-started.mdx to list installed tools and their purpose - taplo-cli is required for make format to work with TOML files

Add comprehensive instructions for testing developer setup scripts using the test-doc-scripts workflow. This ensures documentation stays current and prevents broken installation instructions. Includes: - When to test (script modifications, new dependencies, new platforms) - How to trigger tests using GitHub labels and CLI - What gets tested across platforms - Motivation for on-demand testing approach This helps maintain reliable developer onboarding documentation.

https://www.baeldung.com/linux/gnu-bsd-stream-editor

Add documentation and automation for SQLite database setup required by the heartbeats processor when running 'make check' or 'make lint'. Changes: - Added SQLite database setup section to developer documentation - Updated format-and-lint.sh script to automatically create the database - Referenced tools/heartbeats-processor/schema.sql for schema creation - Set DATABASE_URL environment variable as required by SQLx This prevents 'database connection failed' errors when developers run make check/lint commands.

And redirect to the CI instead. The tests take too much time to run, and it is useless as it is tested in the CI.

dannywillems · 2025-07-25T12:02:51Z

The CI is all green, and it seems to pass all tests on MacOS.
I will bypass the rules to move on as some PRs are blocked by this one.
If any issue arises from this, I would personally fix it.

dannywillems force-pushed the dw/update-instructions-build branch from 618209c to 968a7d5 Compare July 24, 2025 13:35

dannywillems added the test-doc-scripts label Jul 24, 2025

dannywillems force-pushed the dw/update-instructions-build branch from 968a7d5 to fe5b82b Compare July 24, 2025 13:46