From c707659afe188a2b46b093ce3438f64c6b0e1e30 Mon Sep 17 00:00:00 2001 From: Mingwei Samuel Date: Mon, 23 Dec 2024 12:43:19 -0800 Subject: [PATCH] docs: fix some broken github tree/main links --- README.md | 4 ++-- dfir_datalog/src/lib.rs | 2 +- dfir_macro/src/lib.rs | 4 ++-- dfir_rs/src/lib.rs | 2 +- docs/docs/dfir/ecosystem.md | 2 +- 5 files changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 5ea4c91d8da..e1c5850ec8d 100644 --- a/README.md +++ b/README.md @@ -18,9 +18,9 @@ We often describe Hydro via a metaphor: *LLVM for the cloud*. Like LLVM, Hydro i ## The Language (and the Low-Level IR) -Hydro provides a [high-level language](https://hydro.run/docs/hydro) that allows you to program an entire fleet of processes from a single program, and then launch your fleet locally or in the cloud via [Hydro Deploy](https://hydro.run/docs/deploy). Get started with Hydro via the language [documentation](https://hydro.run/docs/hydro) and [examples](https://github.com/hydro-project/hydroflow/tree/main/hydroflow_plus_test/examples). +Hydro provides a [high-level language](https://hydro.run/docs/hydro) that allows you to program an entire fleet of processes from a single program, and then launch your fleet locally or in the cloud via [Hydro Deploy](https://hydro.run/docs/deploy). Get started with Hydro via the language [documentation](https://hydro.run/docs/hydro) and [examples](https://github.com/hydro-project/hydroflow/tree/main/hydro_test/examples). -> Internally, the Hydro stack compiles Hydro programs into a low-level Dataflow Internal Representation (IR) language called [DFIR](https://hydro.run/docs/dfir); each process corresponds to a separate DFIR program. In rare cases you may want to compose one or more processes in DFIR by hand; see the DFIR [documentation](https://hydro.run/docs/dfir) or [examples](https://github.com/hydro-project/hydroflow/tree/main/hydroflow/examples) for details. +> Internally, the Hydro stack compiles Hydro programs into a low-level Dataflow Internal Representation (IR) language called [DFIR](https://hydro.run/docs/dfir); each process corresponds to a separate DFIR program. In rare cases you may want to compose one or more processes in DFIR by hand; see the DFIR [documentation](https://hydro.run/docs/dfir) or [examples](https://github.com/hydro-project/hydroflow/tree/main/dfir_rs/examples) for details. ## Development Setup diff --git a/dfir_datalog/src/lib.rs b/dfir_datalog/src/lib.rs index 4b6152f5117..43d3c633360 100644 --- a/dfir_datalog/src/lib.rs +++ b/dfir_datalog/src/lib.rs @@ -7,7 +7,7 @@ use quote::{quote, ToTokens}; /// /// This uses a variant of Datalog that is similar to [Dedalus](https://www2.eecs.berkeley.edu/Pubs/TechRpts/2009/EECS-2009-173.pdf). /// -/// For examples, see [the datalog tests in the Hydroflow repo](https://github.com/hydro-project/hydroflow/blob/main/hydroflow/tests/datalog_frontend.rs). +/// For examples, see [the datalog tests in the Hydroflow repo](https://github.com/hydro-project/hydroflow/blob/main/dfir_rs/tests/datalog_frontend.rs). // TODO(mingwei): rustdoc examples inline. #[proc_macro] pub fn datalog(item: proc_macro::TokenStream) -> proc_macro::TokenStream { diff --git a/dfir_macro/src/lib.rs b/dfir_macro/src/lib.rs index a072f59e812..fede8d31de7 100644 --- a/dfir_macro/src/lib.rs +++ b/dfir_macro/src/lib.rs @@ -15,8 +15,8 @@ use syn::{ /// Create a Hydroflow instance using Hydroflow's custom "surface syntax." /// -/// For example usage, take a look at the [`surface_*` tests in the `tests` folder](https://github.com/hydro-project/hydroflow/tree/main/hydroflow/tests) -/// or the [`examples` folder](https://github.com/hydro-project/hydroflow/tree/main/hydroflow/examples) +/// For example usage, take a look at the [`surface_*` tests in the `tests` folder](https://github.com/hydro-project/hydroflow/tree/main/dfir_rs/tests) +/// or the [`examples` folder](https://github.com/hydro-project/hydroflow/tree/main/dfir_rs/examples) /// in the [Hydroflow repo](https://github.com/hydro-project/hydroflow). // TODO(mingwei): rustdoc examples inline. #[proc_macro] diff --git a/dfir_rs/src/lib.rs b/dfir_rs/src/lib.rs index c0b36503994..207bb7da2ce 100644 --- a/dfir_rs/src/lib.rs +++ b/dfir_rs/src/lib.rs @@ -14,7 +14,7 @@ //! hf.run_available(); //! ``` //! -//! For more examples, check out the [`examples` folder on Github](https://github.com/hydro-project/hydroflow/tree/main/hydroflow/examples). +//! For more examples, check out the [`examples` folder on Github](https://github.com/hydro-project/hydroflow/tree/main/dfir_rs/examples). pub mod compiled; pub mod scheduled; diff --git a/docs/docs/dfir/ecosystem.md b/docs/docs/dfir/ecosystem.md index 09f41f071d0..7ecb3ecb184 100644 --- a/docs/docs/dfir/ecosystem.md +++ b/docs/docs/dfir/ecosystem.md @@ -15,7 +15,7 @@ Working down from the top: - *Hydrolysis* is a compiler that translates a global Hydro spec to multiple single-threaded DFIR programs, which collectively implement the global spec. This compilation phase is currently a part of the Hydro codebase, but will evolve into a standalone optimizing compiler inspired by database query optimizers and [e-graphs](https://en.wikipedia.org/wiki/E-graph). -- [DFIR and its compiler/runtime](https://github.com/hydro-project/hydroflow/tree/main/hydroflow) are the subject of this book. +- [DFIR and its compiler/runtime](https://github.com/hydro-project/hydroflow/tree/main/dfir_rs) are the subject of this book. Where Hydro is a *global* language for programming a fleet of processes, DFIR is a *local* language for programming a single process that participates in a distributed system. More specifically, DFIR is an internal representation (IR) language and runtime library that generates the low-level Rust code for an individual transducer. As a low-level IR, DFIR is not intended for the general-purpose programmer. For most users it is intended as a readable compiler target from Hydro; advanced developers can also use it to manually program individual transducers. - [HydroDeploy](../deploy) is a service for launching DFIR transducers on a variety of platforms.