Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ To get started please read Docusaurus [getting started guide](https://docusaurus
### Installation

```bash
git clone https://github.com/passbolt/passbolt_help.git
cd passbolt_help
git clone https://github.com/passbolt/passbolt-docs.git
cd passbolt-docs
npm install
```

Expand Down Expand Up @@ -63,7 +63,7 @@ Our doc is separated into two main categories: Admin guide, User guide.

The first level of each category are registered in their respective *.sidebar.js (e.g.: admin.sidebar.js handles the admin guide sidebar). It offers the ability to define the order of the first levels.

All the other levels are auto-generated, which means they will appear automatically under the first level item.
All the other levels are auto-generated, which means they will appear automatically under the first level item.

> See Docusaurus documentation about the sidebar: [https://docusaurus.io/docs/sidebar](https://docusaurus.io/docs/sidebar)

Expand Down Expand Up @@ -98,4 +98,4 @@ All the static assets are stored in the /static folder.

Images used in the doc file should be added to the /static folder, following the same folder structure as the documentation file.

> E.g.: I need to add an image to a documentation file located in /docs/hosting/setup/configuration/firewall-rules.mdx. The image should be uploaded under /static/admin/setup/configuration/firewall-rules/filename.png.
> E.g.: I need to add an image to a documentation file located in /docs/hosting/setup/configuration/firewall-rules.mdx. The image should be uploaded under /static/admin/setup/configuration/firewall-rules/filename.png.