Skip to content

Commit df929a0

Browse files
authored
Update README.md
1 parent f6aab23 commit df929a0

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

README.md

+11-5
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,20 @@
11
# Nemo Documentation
2+
[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)
23

3-
The documentation of the [Nemo rule engine](https://github.com/knowsys/nemo) is in the process of being built in this repository.
4+
This repository contains the sources for the documentation of the [Nemo rule engine](https://github.com/knowsys/nemo).
5+
To read the documentation, please go to the official [Nemo documentation pages](https://knowsys.github.io/nemo-doc/).
6+
The content of the main branch of this repository is automatically deployed at this place.
47

5-
For now, you can find the documentation in the [Nemo wiki pages](https://github.com/knowsys/nemo/wiki).
8+
## Contributing
69

7-
[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)
10+
Found a typo? Want to suggest an improvement? We appreciate your contributions in two ways:
11+
- [Report an issue](https://github.com/knowsys/nemo-doc/issues) in this repository
12+
- Implement a change in the sources and create a pull request
813

9-
## Commands
14+
## Building this Documentation
1015

11-
All commands are run from the root of the project, from a terminal:
16+
Contributors who want to create the documentation on their own machine (e.g., for preview)
17+
can use the following commands. All commands are run from the root of the project, from a terminal:
1218

1319
| Command | Action |
1420
| :------------------------ | :----------------------------------------------- |

0 commit comments

Comments
 (0)