{"id":43003421,"url":"https://github.com/nmshd/documentation","last_synced_at":"2026-01-31T04:33:12.592Z","repository":{"id":37483118,"uuid":"409523021","full_name":"nmshd/documentation","owner":"nmshd","description":"enmeshed Documentation Repository","archived":false,"fork":false,"pushed_at":"2025-12-12T16:19:27.000Z","size":42727,"stargazers_count":4,"open_issues_count":0,"forks_count":4,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-12-14T07:30:55.677Z","etag":null,"topics":["documentation","enmeshed"],"latest_commit_sha":null,"homepage":"https://enmeshed.eu","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nmshd.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2021-09-23T09:10:59.000Z","updated_at":"2025-12-12T16:19:04.000Z","dependencies_parsed_at":"2024-04-15T15:31:24.860Z","dependency_job_id":"d1908ed2-1a7a-4135-8c7b-7ec03b6d9fef","html_url":"https://github.com/nmshd/documentation","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/nmshd/documentation","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nmshd%2Fdocumentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nmshd%2Fdocumentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nmshd%2Fdocumentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nmshd%2Fdocumentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nmshd","download_url":"https://codeload.github.com/nmshd/documentation/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nmshd%2Fdocumentation/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28929701,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-31T04:05:25.756Z","status":"ssl_error","status_checked_at":"2026-01-31T04:02:35.005Z","response_time":128,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","enmeshed"],"created_at":"2026-01-31T04:33:11.801Z","updated_at":"2026-01-31T04:33:12.575Z","avatar_url":"https://github.com/nmshd.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Documentation\n\nThis is the source code of the enmeshed documentation hosted at [enmeshed.eu](https://enmeshed.eu).\n\n## Purpose of this documentation\n\nThis 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.\n\n## Documentation guidelines\n\n- So far, English only\n- Keep it simple\n- Think about the audience\n- Links to other pages of the documentation are rendered using jekyll's liquid:\n  `{% link {path_to_file} %}#{fragment_identifier}`\n\n## Contribute to the documentation\n\nThe documentation itself uses GitHub pages and thus `jekyll` as the technical framework.  \nThe preferred way of setting up a local \"instance\" of the environment is via a so-called \"Development Container\" in VS Code:\n\nVSCode\nJavaScript\n\nInstall:\n\n- [Visual Studio Code](https://code.visualstudio.com/)\n- [Dev Containers Extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)\n- [Docker](https://code.visualstudio.com/docs/remote/containers)\n\nThen 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)_\n\nThis will\n\n- Clone the Repository in a Container Volume\n- Build the Docker Image\n- Start the Docker Container and map the required ports\n- Mount the created Container Volume\n- Install the required npm packages\n- Install the required ruby gems\n\nFinally, open the `Terminal` in VS Code (it is attached to the running Development Container), and start the \"instance\":\n\n```shell\nbundle exec jekyll serve --livereload\n```\n\nAlternatively, you can use the predefined VS Code Tasks\n\n- `Serve` \u0026rarr; see above\n- `Build` \u0026rarr; build the jekyll site\n\n## Update dependencies\n\nYou can update dependencies using the command `bundle update`.\n\n## Regenerate diagrams\n\nTo regenerate diagrams, execute the command\n\n```shell\njava -jar puml.jar _docs_integrate/diagrams/*.pu -o \"$PWD/assets/diagrams/integrate\"\n\n```\n\n## Regenerate header\n\n1. add excel file to root directory\n2. execute script\n\n```shell\nnpx ts-node scripts/update.ts\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnmshd%2Fdocumentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnmshd%2Fdocumentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnmshd%2Fdocumentation/lists"}