diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 020fc68e75..e064ae814b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# Contributing to Foxglove Studio +# Contributing to Foxbox **Supported development environments:** Linux, Windows, macOS @@ -42,7 +42,7 @@ $ yarn test:watch # run tests on changed files ## Localization -At this time, first-class support for Foxglove Studio is provided in English only. Localization into other languages is available on a best-effort basis, with translations provided by community volunteers. Current community supported-languages are: +At this time, first-class support for Foxbox is provided in English only. Localization into other languages is available on a best-effort basis, with translations provided by community volunteers. Current community supported-languages are: - Chinese - Japanese @@ -56,7 +56,7 @@ Translation support is implemented using [`react-i18next`](https://react.i18next ### Add translations to the `i18n` directory -The [`i18n` directory](packages/studio-base/src/i18n) contains translated (localized) strings for all languages supported by Foxglove Studio. +The [`i18n` directory](packages/studio-base/src/i18n) contains translated (localized) strings for all languages supported by Foxbox. Translated strings are organized into _namespaces_ — e.g. [`i18n/[language]/appSettings.ts`](packages/studio-base/src/i18n/en/appSettings.ts) contains translations for the app's Settings tab. diff --git a/README.md b/README.md index 95cb0dda11..5a825abec8 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@
-

Foxglove Studio

+

Foxbox

@@ -24,10 +24,10 @@

-[Foxglove Studio](https://foxglove.dev) is an integrated visualization and diagnosis tool for robotics, available [in your browser](https://studio.foxglove.dev/) or [as a desktop app](https://foxglove.dev/download) on Linux, Windows, and macOS. +[Foxbox](https://foxglove.dev) is an integrated visualization and diagnosis tool for robotics, available [in your browser](https://studio.foxglove.dev/) or [as a desktop app](https://foxglove.dev/download) on Linux, Windows, and macOS.

- Foxglove Studio screenshot + Foxbox screenshot

@@ -59,23 +59,23 @@ You can join us on the following platforms to ask questions, share feedback, and ## Installation -Foxglove Studio is available online at [studio.foxglove.dev](https://studio.foxglove.dev/), or desktop releases can be downloaded from [foxglove.dev/download](https://foxglove.dev/download). +Foxbox is available online at [studio.foxglove.dev](https://studio.foxglove.dev/), or desktop releases can be downloaded from [foxglove.dev/download](https://foxglove.dev/download). ## Open Source -Foxglove Studio follows an open core licensing model. Most functionality is available in this repository, and can be reproduced or modified per the terms of the [Mozilla Public License v2.0](/LICENSE). +Foxbox follows an open core licensing model. Most functionality is available in this repository, and can be reproduced or modified per the terms of the [Mozilla Public License v2.0](/LICENSE). The official binary distributions available at [studio.foxglove.dev](https://studio.foxglove.dev/) or [foxglove.dev/download](https://foxglove.dev/download) incorporate some closed-source functionality, such as integration with [Foxglove Data Platform](https://foxglove.dev/data-platform), multiple layouts, private extensions, and more. For more information on free and paid features, see our [Pricing](https://foxglove.dev/pricing). ## Self-hosting -Foxglove Studio can be self-hosted using our [docker image](https://ghcr.io/foxglove/studio). Please note that this build does not contain any closed source functionality. +Foxbox can be self-hosted using our [docker image](https://ghcr.io/foxglove/studio). Please note that this build does not contain any closed source functionality. ```sh docker run --rm -p "8080:8080" ghcr.io/foxglove/studio:latest ``` -Foxglove Studio will be accessible in your browser at [localhost:8080](http://localhost:8080/). +Foxbox will be accessible in your browser at [localhost:8080](http://localhost:8080/). ### Overriding the default layout @@ -87,10 +87,10 @@ docker run --rm -p "8080:8080" -v /path/to/custom_layout.json:/foxglove/default- ## Contributing -Foxglove Studio is written in TypeScript – contributions are welcome! +Foxbox is written in TypeScript – contributions are welcome! Note: All contributors must agree to our [Contributor License Agreement](https://github.com/foxglove/cla). See [CONTRIBUTING.md](CONTRIBUTING.md) for more details. ## Credits -Foxglove Studio originally began as a fork of [Webviz](https://github.com/cruise-automation/webviz), an open source project developed by [Cruise](https://getcruise.com/). Most of the Webviz code has been rewritten, but some files still carry a Cruise license header where appropriate. +Foxbox originally began as a fork of [Webviz](https://github.com/cruise-automation/webviz), an open source project developed by [Cruise](https://getcruise.com/). Most of the Webviz code has been rewritten, but some files still carry a Cruise license header where appropriate. diff --git a/benchmark/README.md b/benchmark/README.md index 08f91280c7..b4376a1192 100644 --- a/benchmark/README.md +++ b/benchmark/README.md @@ -1,4 +1,4 @@ -# Foxglove Studio Benchmarking +# Foxbox Benchmarking Benchmarks are specific combinations of layout and synthetic data playback. When a benchmark is opened, playback automatically starts and summary results are printed to the developer console. diff --git a/package.json b/package.json index e5abf3266d..6b01307538 100644 --- a/package.json +++ b/package.json @@ -3,9 +3,9 @@ "version": "1.0.0", "license": "MPL-2.0", "private": true, - "productName": "Foxglove", - "description": "Core components of Foxglove Studio", - "productDescription": "Foxglove Studio", + "productName": "Foxbox", + "description": "Core components of Foxbox", + "productDescription": "Foxbox", "packageManager": "yarn@3.6.3", "repository": { "type": "git", diff --git a/packages/studio-base/README.md b/packages/studio-base/README.md index e476452a59..4881b3c983 100644 --- a/packages/studio-base/README.md +++ b/packages/studio-base/README.md @@ -1,10 +1,10 @@ # @foxglove/studio-base   [![npm version](https://img.shields.io/npm/v/@foxglove/studio-base.svg?style=flat)](https://www.npmjs.com/package/@foxglove/studio-base) -This package contains core components used in [Foxglove Studio](https://github.com/foxglove/studio). +This package contains core components used in [Foxbox](https://github.com/foxglove/studio). ## Quick start -When contributing to the [Foxglove Studio](https://github.com/foxglove/studio) codebase, you can import from `@foxglove/studio-base` at its top-level or from lower in its directory: +When contributing to the [Foxbox](https://github.com/foxglove/studio) codebase, you can import from `@foxglove/studio-base` at its top-level or from lower in its directory: ``` import { ExtensionInfo, ExtensionLoaderContext, ExtensionLoader } from "@foxglove/studio-base"; diff --git a/packages/studio-base/src/PanelAPI/README.md b/packages/studio-base/src/PanelAPI/README.md index b336b81421..6fe2f6f720 100644 --- a/packages/studio-base/src/PanelAPI/README.md +++ b/packages/studio-base/src/PanelAPI/README.md @@ -1,6 +1,6 @@ # PanelAPI -The `PanelAPI` namespace contains React [Hooks](https://reactjs.org/docs/hooks-intro.html) and components which allow panel authors to access Foxglove Studio data and metadata inside their panels. Using these APIs across all panels helps ensure that data appears consistent among panels, and makes it easier for panels to support advanced features (such as multiple simultaneous data sources). +The `PanelAPI` namespace contains React [Hooks](https://reactjs.org/docs/hooks-intro.html) and components which allow panel authors to access Foxbox data and metadata inside their panels. Using these APIs across all panels helps ensure that data appears consistent among panels, and makes it easier for panels to support advanced features (such as multiple simultaneous data sources). To use PanelAPI, it's recommended that you import the whole namespace, so that all usage sites look consistent, like `PanelAPI.useSomething()`. @@ -10,7 +10,7 @@ import * as PanelAPI from "@foxglove/studio-base/PanelAPI"; ## [`PanelAPI.useDataSourceInfo()`](useDataSourceInfo.js) -"Data source info" encapsulates **rarely-changing** metadata about the sources from which Foxglove Studio is loading data. (A data source might be a local [bag file](http://wiki.ros.org/Bags/Format) dropped into the browser, or a bag stored on a remote server; see [players](../players) and [dataSources](../dataSources) for more details.) +"Data source info" encapsulates **rarely-changing** metadata about the sources from which Foxbox is loading data. (A data source might be a local [bag file](http://wiki.ros.org/Bags/Format) dropped into the browser, or a bag stored on a remote server; see [players](../players) and [dataSources](../dataSources) for more details.) Using this hook inside a panel will cause the panel to re-render automatically when the metadata changes, but this won't happen very often or during playback. @@ -63,7 +63,7 @@ These reducers should be wrapped in [`useCallback()`](https://reactjs.org/docs/h - `restore: (?T) => T`: - - Called with `undefined` to initialize a new state when the panel first renders, and when the user seeks to a different playback time (at which point Foxglove Studio automatically clears out state across all panels). + - Called with `undefined` to initialize a new state when the panel first renders, and when the user seeks to a different playback time (at which point Foxbox automatically clears out state across all panels). - Called with the previous state when the `restore` or `addMessage`/`addMessages` reducer functions change. This allows the panel an opportunity to reuse its previous state when a parameter changes, without totally discarding it (as in the case of a seek) and waiting for new messages to come in from the data source. For example, a panel that filters some incoming messages can use `restore` to create a filtered value immediately when the filter changes. To implement this, the caller might switch from unfiltered reducers: diff --git a/packages/studio-base/src/i18n/README.md b/packages/studio-base/src/i18n/README.md index 7b6b7013d6..a7fbc5f933 100644 --- a/packages/studio-base/src/i18n/README.md +++ b/packages/studio-base/src/i18n/README.md @@ -1,3 +1,3 @@ -This directory contains localized strings for languages supported by Foxglove Studio. +This directory contains localized strings for languages supported by Foxbox. To learn more about localization, see [CONTRIBUTING.md](../../../../CONTRIBUTING.md#localization). diff --git a/packages/studio-base/src/players/IterablePlayer/rosdb3/RosDb3IterableSource.ts b/packages/studio-base/src/players/IterablePlayer/rosdb3/RosDb3IterableSource.ts index 1cc498a221..147d8ff71c 100644 --- a/packages/studio-base/src/players/IterablePlayer/rosdb3/RosDb3IterableSource.ts +++ b/packages/studio-base/src/players/IterablePlayer/rosdb3/RosDb3IterableSource.ts @@ -18,11 +18,11 @@ import { RosDatatypes } from "@foxglove/studio-base/types/RosDatatypes"; import { basicDatatypes } from "@foxglove/studio-base/util/basicDatatypes"; import { + GetBackfillMessagesArgs, IIterableSource, - IteratorResult, Initalization, + IteratorResult, MessageIteratorArgs, - GetBackfillMessagesArgs, } from "../IIterableSource"; export class RosDb3IterableSource implements IIterableSource { @@ -84,7 +84,7 @@ export class RosDb3IterableSource implements IIterableSource { problems.push({ severity: "warn", message: `Topic "${topicDef.name}" has unsupported datatype "${topicDef.type}"`, - tip: "ROS 2 .db3 files do not contain message definitions, so only well-known ROS types are supported in Foxbox Studio. As a workaround, you can convert the db3 file to mcap using the mcap CLI. For more information, see: https://docs.foxglove.dev/docs/connecting-to-data/frameworks/ros2", + tip: "ROS 2 .db3 files do not contain message definitions, so only well-known ROS types are supported in Foxbox. As a workaround, you can convert the db3 file to mcap using the mcap CLI. For more information, see: https://docs.foxglove.dev/docs/connecting-to-data/frameworks/ros2", }); continue; } diff --git a/packages/studio-desktop/README.md b/packages/studio-desktop/README.md index f711a4e092..f7204294c1 100644 --- a/packages/studio-desktop/README.md +++ b/packages/studio-desktop/README.md @@ -1,3 +1,3 @@ # @foxglove/studio-desktop -This is an internal package used for bundling the Foxglove Studio desktop app. Its API is not considered public or stable. +This is an internal package used for bundling the Foxbox desktop app. Its API is not considered public or stable. diff --git a/packages/studio-desktop/src/electronBuilderConfig.js b/packages/studio-desktop/src/electronBuilderConfig.js index 7859fab703..9d9c26cd58 100644 --- a/packages/studio-desktop/src/electronBuilderConfig.js +++ b/packages/studio-desktop/src/electronBuilderConfig.js @@ -74,7 +74,7 @@ function makeElectronBuilderConfig(params) { }, { ext: "foxe", - name: "Foxbox Studio Extension", + name: "Foxbox Extension", mimeType: "application/zip", }, ], @@ -125,7 +125,7 @@ function makeElectronBuilderConfig(params) { { CFBundleTypeExtensions: ["foxe"], CFBundleTypeIconFile: "FoxeIcon", - CFBundleTypeName: "Foxbox Studio Extension File", + CFBundleTypeName: "Foxbox Extension File", CFBundleTypeRole: "Viewer", LSHandlerRank: "Owner", CFBundleTypeIconSystemGenerated: 1, @@ -149,7 +149,7 @@ function makeElectronBuilderConfig(params) { }, { UTTypeConformsTo: ["public.data", "public.archive", "public.zip-archive"], - UTTypeDescription: "Foxbox Studio Extension File", + UTTypeDescription: "Foxbox Extension File", UTTypeIcons: { UTTypeIconText: "foxe" }, UTTypeIdentifier: "dev.foxglove.extension", UTTypeTagSpecification: { "public.filename-extension": "foxe" }, @@ -171,7 +171,7 @@ function makeElectronBuilderConfig(params) { appx: { applicationId: "FoxgloveStudio", backgroundColor: "#f7def6", - displayName: "Foxbox Studio", + displayName: "Foxbox", identityName: "Foxglove.Studio", publisher: "CN=Foxglove Technologies, O=Foxglove Technologies, L=San Francisco, S=California, C=US", diff --git a/packages/studio-web/README.md b/packages/studio-web/README.md index 77e9ea2531..bdbbd44bf5 100644 --- a/packages/studio-web/README.md +++ b/packages/studio-web/README.md @@ -1,3 +1,3 @@ # @foxglove/studio-web -This is an internal package used for bundling the Foxglove Studio web app. Its API is not considered public or stable. +This is an internal package used for bundling the Foxbox web app. Its API is not considered public or stable. diff --git a/packages/studio/README.md b/packages/studio/README.md index c37d0289a8..afe5574b19 100644 --- a/packages/studio/README.md +++ b/packages/studio/README.md @@ -1,6 +1,6 @@ -# Foxglove Studio Extension API +# Foxbox Extension API -This package contains type definitions for writing [Foxglove Studio](https://foxglove.dev/) extensions. +This package contains type definitions for writing [Foxbox](https://foxglove.dev/) extensions. See https://docs.foxglove.dev/docs/visualization/extensions/introduction diff --git a/packages/theme/src/i18n/README.md b/packages/theme/src/i18n/README.md index 7b6b7013d6..a7fbc5f933 100644 --- a/packages/theme/src/i18n/README.md +++ b/packages/theme/src/i18n/README.md @@ -1,3 +1,3 @@ -This directory contains localized strings for languages supported by Foxglove Studio. +This directory contains localized strings for languages supported by Foxbox. To learn more about localization, see [CONTRIBUTING.md](../../../../CONTRIBUTING.md#localization). diff --git a/web/README.md b/web/README.md index e90b3e4251..2092b6ab0e 100644 --- a/web/README.md +++ b/web/README.md @@ -1 +1 @@ -This is an internal package used for bundling the Foxglove Studio web app. Its API is not considered public or stable. +This is an internal package used for bundling the Foxbox web app. Its API is not considered public or stable.