Help and documentation for Ente's products.

You can find the live version of these at ente.com/help.

You can edit these files directly on GitHub and open a pull request. ente.com/help will automatically get updated with your changes in a few minutes after your pull request is merged.

The above workflow is great since it doesn't require you to setup anything on your local machine. But if you plan on contributing frequently, you might find it easier to run things locally.

Clone this repository

git clone https://github.com/ente-io/ente

Change to this directory

cd ente/docs

Install dependencies

npm ci

Use plain npm install only when you are intentionally updating dependencies and reviewing the resulting package-lock.json changes.

Then start a local server

npm run dev

For an editor, VSCode is a good choice. Also install the Prettier extension for VSCode, and set VSCode to format on save. This way the editor will automatically format and wrap the text using the project's standard, so you can just focus on the content. You can also format without VSCode by using the npm run pretty command.

If you're unsure about how to do something, just look around in the other files and copy paste whatever seems to match the look of what you're trying to do. And remember, writing docs should not be a chore, have fun!