Skip to content

Commit

Permalink
docs: Prepare for integration on docs.cozy.io (#2333)
Browse files Browse the repository at this point in the history
  • Loading branch information
sblaisot authored Nov 20, 2023
1 parent e4d8cfa commit 79bbb4c
Show file tree
Hide file tree
Showing 4 changed files with 53 additions and 4 deletions.
29 changes: 29 additions & 0 deletions doc/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: Cozy-Desktop documentation - Table of contents
---

## Usage

- [Build](./usage/build.md)
- [CLI](./usage/cli.md)
- [Filesystems](./usage/file_systems.md)
- [Ignore files"](./usage/ignore_files.md)
- [inotify](./usage/inotify.md)
- [Limitations](./usage/limitations.md)
- [Linux](./usage/linux.md)
- [MacOS](./usage/macos.md)
- [Windows](./usage/windows.md)

## Developer

- [API Documentation](./developer/api_doc.md)
- [Cofeescript](./developer/coffeescript.md)
- [Debug](./developer/debug.md)
- [Log analysis](./developer/log_analysis.md)
- [Requirements](./developer/requirements.md)
- [Setup](./developer/setup.md)
- [Test](./developer/setup.md)

## Other

- [Feddback](./feedback.md)
2 changes: 1 addition & 1 deletion doc/developer/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ N.B.: the address of the development cozy-stack is http://cozy.localhost:8080. D

## Run tests

See [./test.md](./test.md).
See [test](./test.md).

## Develop Elm

Expand Down
6 changes: 3 additions & 3 deletions doc/developer/test.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,11 +129,11 @@ Implementation details:
`./test/support/coverage.js`.
2. `./test/support/coverage.js` uses [istanbul][3] to instrument the code in a
way compatible with [electron-mocha][4].
2. `babel-plugin-istanbul` inserts instrumentation code when compiling from
3. `babel-plugin-istanbul` inserts instrumentation code when compiling from
EcmaScript to JavaScript
3. The mocha tests are run and generate an lcov-style report (including
4. The mocha tests are run and generate an lcov-style report (including
HTML output)
4. Finally, when run on the CI, we [tell Travis](../.travis.yml) to upload the report to the
5. Finally, when run on the CI, we [tell Travis](../.travis.yml) to upload the report to the
[Codecov][5] service.


Expand Down
20 changes: 20 additions & 0 deletions doc/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
- README: ./README.md
- Usage:
- "Build": ./usage/build.md
- "CLI": ./usage/cli.md
- "Filesystems": ./usage/file_systems.md
- "Ignore files": ./usage/ignore_files.md
- "inotify": ./usage/inotify.md
- "Limitations": ./usage/limitations.md
- "Linux": ./usage/linux.md
- "MacOS": ./usage/macos.md
- "Windows": ./usage/windows.md
- Developer:
- "API Documentation": ./developer/api_doc.md
- "Cofeescript": ./developer/coffeescript.md
- "Debug": ./developer/debug.md
- "Log analysis": ./developer/log_analysis.md
- "Requirements": ./developer/requirements.md
- "Setup": ./developer/setup.md
- "Test": ./developer/setup.md
- Feddback: ./feedback.md

0 comments on commit 79bbb4c

Please sign in to comment.