diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9265e4c38..55acb5a3c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,14 +1,14 @@ # Contributing Guide # -Thank you for your interest in contributing to UXBox. This is a -generic guide that details how to contribute to UXBox in a way that is +Thank you for your interest in contributing to Penpot. This is a +generic guide that details how to contribute to Penpot in a way that is efficient for everyone. If you want a specific documentation for different parts of the platform, please refer to `docs/` directory. ## Reporting Bugs ## -We are using [GitHub Issues](https://github.com/uxbox/uxbox/issues) +We are using [GitHub Issues](https://github.com/penpot/penpot/issues) for our public bugs. We keep a close eye on this and try to make it clear when we have an internal fix in progress. Before filing a new task, try to make sure your problem doesn't already exist. diff --git a/docs/01-Development-Environment.md b/docs/01-Development-Environment.md index cf91ff22b..bb5771ebf 100644 --- a/docs/01-Development-Environment.md +++ b/docs/01-Development-Environment.md @@ -1,6 +1,6 @@ # Developer Guide # -This is a generic "getting started" guide for the uxbox platform. It +This is a generic "getting started" guide for the Penpot platform. It intends to explain how to get the development environment up and running with many additional tips. @@ -148,7 +148,7 @@ For more information, please refer to: `03-Backend-Guide.md`. ## Start the testenv ## The purpose of the testenv (Test Environment) is provide an easy way -to get uxbox running in local pc without getting into the full +to get Penpot running in local pc without getting into the full development environment. As first step we still need to build devenv image because that image diff --git a/docs/02-Frontend-Developer-Guide.md b/docs/02-Frontend-Developer-Guide.md index 55aa0d861..50b137c92 100644 --- a/docs/02-Frontend-Developer-Guide.md +++ b/docs/02-Frontend-Developer-Guide.md @@ -124,7 +124,7 @@ Some keys ara treated as special cases for helping in debugging: ## Access to clojure from javascript console -The uxbox namespace of the main application is exported, so that is +The penpot namespace of the main application is exported, so that is accessible from javascript console in Chrome developer tools. Object names and data types are converted to javascript style. For example you can emit the event to reset zoom level by typing this at the diff --git a/docs/04-Common-Developer-Guide.md b/docs/04-Common-Developer-Guide.md index 3838edf82..366d577ae 100644 --- a/docs/04-Common-Developer-Guide.md +++ b/docs/04-Common-Developer-Guide.md @@ -6,7 +6,7 @@ and backend, such as: code style hints, architecture dicisions, etc... ## Assertions ## -UXBOX source code has this types of assertions: +Penpot source code has this types of assertions: **assert**: just using the clojure builtin `assert` macro. @@ -55,7 +55,7 @@ This macro enables you have assetions on production code. **Why don't use the `clojure.spec.alpha/assert` instead of the `app.common.spec/assert`?** -The uxbox variant does not peforms additional runtime checks for know +The Penpot variant does not peforms additional runtime checks for know if asserts are disabled in "runtime". As a result it generates much simplier code at development and production builds.