Skip to content

Commit

Permalink
Merge pull request #773 from MAIF/mail-editor
Browse files Browse the repository at this point in the history
Mail editor
  • Loading branch information
Zwiterrion authored Dec 3, 2024
2 parents a840dfd + 18276a9 commit 20c0141
Show file tree
Hide file tree
Showing 83 changed files with 13,839 additions and 20,286 deletions.
21 changes: 19 additions & 2 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,9 +64,26 @@ You must add the dependency and its licence in https://github.com/MAIF/daikoku/b

if you add features to Daikoku, don't forget to modify the user documentation

* https://github.com/MAIF/daikoku/tree/master/docs/manual
* https://github.com/MAIF/daikoku/tree/master/docs

to build the documentation, run the following command at the root of the repository
To run the documentation locally

Navigate to the `manual` folder and install the Docusaurus dependencies:
```sh
cd manual && npm install
```

Launch the documentation server, then edit the markdown files located in the manual folder:
```sh
npm run start
```

To test the search bar, build the project first:
```sh
npm run build
```

to build the documentation, run the following command at the root of the repository:

```sh
sh ./scripts/build.sh manual
Expand Down
Loading

0 comments on commit 20c0141

Please sign in to comment.