https://github.com/nmshd/documentation
enmeshed Documentation Repository
https://github.com/nmshd/documentation
documentation enmeshed
Last synced: 5 months ago
JSON representation
enmeshed Documentation Repository
- Host: GitHub
- URL: https://github.com/nmshd/documentation
- Owner: nmshd
- Created: 2021-09-23T09:10:59.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2025-12-12T16:19:27.000Z (6 months ago)
- Last Synced: 2025-12-14T07:30:55.677Z (6 months ago)
- Topics: documentation, enmeshed
- Language: JavaScript
- Homepage: https://enmeshed.eu
- Size: 40.7 MB
- Stars: 4
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Documentation
This is the source code of the enmeshed documentation hosted at [enmeshed.eu](https://enmeshed.eu).
## Purpose of this documentation
This documentation is meant as an overarching documentation for the whole enmeshed open source project. It describes overarching concepts whereas the individual repositories provide technical documentation for the respective source code or functionality.
## Documentation guidelines
- So far, English only
- Keep it simple
- Think about the audience
- Links to other pages of the documentation are rendered using jekyll's liquid:
`{% link {path_to_file} %}#{fragment_identifier}`
## Contribute to the documentation
The documentation itself uses GitHub pages and thus `jekyll` as the technical framework.
The preferred way of setting up a local "instance" of the environment is via a so-called "Development Container" in VS Code:
VSCode
JavaScript
Install:
- [Visual Studio Code](https://code.visualstudio.com/)
- [Dev Containers Extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
- [Docker](https://code.visualstudio.com/docs/remote/containers)
Then in VS Code, clone the repository with the command _[Dev Containers: Clone Repository in Container Volume...](https://code.visualstudio.com/docs/remote/containers-advanced#_use-clone-repository-in-container-volume)_
This will
- Clone the Repository in a Container Volume
- Build the Docker Image
- Start the Docker Container and map the required ports
- Mount the created Container Volume
- Install the required npm packages
- Install the required ruby gems
Finally, open the `Terminal` in VS Code (it is attached to the running Development Container), and start the "instance":
```shell
bundle exec jekyll serve --livereload
```
Alternatively, you can use the predefined VS Code Tasks
- `Serve` → see above
- `Build` → build the jekyll site
## Update dependencies
You can update dependencies using the command `bundle update`.
## Regenerate diagrams
To regenerate diagrams, execute the command
```shell
java -jar puml.jar _docs_integrate/diagrams/*.pu -o "$PWD/assets/diagrams/integrate"
```
## Regenerate header
1. add excel file to root directory
2. execute script
```shell
npx ts-node scripts/update.ts
```