3pp-mirror/penpot
1
0
Fork 0
mirror of https://github.com/penpot/penpot.git synced 2025-05-05 21:55:54 +02:00
Code Issues Projects Releases Packages Wiki Activity

📚 Updated docs to Penpot

Browse source
This commit is contained in:
alonso.torres 2020-10-28 09:34:47 +01:00
parent 154b58057a
commit 8fa0a039c4
4 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
CONTRIBUTING.md
View file

@ -1,14 +1,14 @@
# Contributing Guide # # Contributing Guide #
Thank you for your interest in contributing to UXBox. This is a Thank you for your interest in contributing to Penpot. This is a
generic guide that details how to contribute to UXBox in a way that is generic guide that details how to contribute to Penpot in a way that is
efficient for everyone. If you want a specific documentation for efficient for everyone. If you want a specific documentation for
different parts of the platform, please refer to `docs/` directory. different parts of the platform, please refer to `docs/` directory.
## Reporting Bugs ## ## 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 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 clear when we have an internal fix in progress. Before filing a new
task, try to make sure your problem doesn't already exist. task, try to make sure your problem doesn't already exist.

4
docs/01-Development-Environment.md
View file

@ -1,6 +1,6 @@
# Developer Guide # # 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 intends to explain how to get the development environment up and
running with many additional tips. running with many additional tips.
@ -148,7 +148,7 @@ For more information, please refer to: `03-Backend-Guide.md`.
## Start the testenv ## ## Start the testenv ##
The purpose of the testenv (Test Environment) is provide an easy way 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. development environment.
As first step we still need to build devenv image because that image As first step we still need to build devenv image because that image

2
docs/02-Frontend-Developer-Guide.md
View file

@ -124,7 +124,7 @@ Some keys ara treated as special cases for helping in debugging:
## Access to clojure from javascript console ## 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 accessible from javascript console in Chrome developer tools. Object
names and data types are converted to javascript style. For example 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 you can emit the event to reset zoom level by typing this at the

4
docs/04-Common-Developer-Guide.md
View file

@ -6,7 +6,7 @@ and backend, such as: code style hints, architecture dicisions, etc...
## Assertions ## ## 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. **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`?** **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 if asserts are disabled in "runtime". As a result it generates much
simplier code at development and production builds. simplier code at development and production builds.