2023-12-16 12:48:47 +00:00
|
|
|
# Docs
|
2024-03-01 04:01:08 +00:00
|
|
|
|
|
|
|
|
Help and documentation for Ente's products
|
2023-12-16 12:48:47 +00:00
|
|
|
|
|
|
|
|
## Running
|
2024-03-01 04:01:08 +00:00
|
|
|
|
|
|
|
|
Install dependencies
|
|
|
|
|
|
|
|
|
|
```sh
|
|
|
|
|
yarn install
|
2023-12-16 12:48:47 +00:00
|
|
|
```
|
2024-03-01 04:01:08 +00:00
|
|
|
|
|
|
|
|
Then start a local server
|
|
|
|
|
|
|
|
|
|
```sh
|
|
|
|
|
yarn dev
|
2023-12-16 12:48:47 +00:00
|
|
|
```
|
2024-03-01 04:08:18 +00:00
|
|
|
|
|
|
|
|
## Workflow
|
|
|
|
|
|
|
|
|
|
You can edit these files directly on GitHub and open a pull request. That is the
|
|
|
|
|
easiest workflow to get started without needing to install anything on your
|
|
|
|
|
local machine.
|
|
|
|
|
|
|
|
|
|
If you plan on contributing frequently, we recommend using an editor. VSCode is
|
|
|
|
|
a good choice. Also install the Prettier extension for VSCode, and set VSCode to
|
|
|
|
|
format on save. This will use the standard formatting and text wrapping options
|
|
|
|
|
for this project, so you can just focus on the content.
|
|
|
|
|
|
|
|
|
|
We currently don't enforce the prettier formatting to make it easy for people
|
|
|
|
|
unfamiliar with programming to also be able to make edits from GitHub directly.
|
|
|
|
|
|
2024-03-01 04:27:28 +00:00
|
|
|
This is a common theme - unlike the rest of the codebase where we expect some
|
2024-03-01 04:08:18 +00:00
|
|
|
baseline understanding of the tools involved, the docs are meant to be a place
|
|
|
|
|
for non-technical people to also provide their input. The reason for this is not
|
|
|
|
|
to increase the number of docs, but to bring more diversity to them. Such
|
|
|
|
|
diversity of viewpoints is essential for evolving documents that can be of help
|
|
|
|
|
to people of varying level of familiarity with tech.
|
