{"id":23469932,"url":"https://github.com/vapor-ware/synse-docs","last_synced_at":"2025-04-12T23:46:19.499Z","repository":{"id":35656462,"uuid":"186690824","full_name":"vapor-ware/synse-docs","owner":"vapor-ware","description":"Hosted documentation for Synse projects","archived":false,"fork":false,"pushed_at":"2023-09-28T20:25:46.000Z","size":605,"stargazers_count":0,"open_issues_count":5,"forks_count":1,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-03-21T22:03:10.330Z","etag":null,"topics":["documentation","synse"],"latest_commit_sha":null,"homepage":"https://synse.readthedocs.io","language":"Groovy","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vapor-ware.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/contributing.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null}},"created_at":"2019-05-14T19:55:52.000Z","updated_at":"2021-10-12T13:18:27.000Z","dependencies_parsed_at":"2023-01-16T02:18:55.660Z","dependency_job_id":null,"html_url":"https://github.com/vapor-ware/synse-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vapor-ware%2Fsynse-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vapor-ware%2Fsynse-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vapor-ware%2Fsynse-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vapor-ware%2Fsynse-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vapor-ware","download_url":"https://codeload.github.com/vapor-ware/synse-docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248647256,"owners_count":21139081,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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","synse"],"created_at":"2024-12-24T15:36:55.195Z","updated_at":"2025-04-12T23:46:19.476Z","avatar_url":"https://github.com/vapor-ware.png","language":"Groovy","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Synse Docs\n\nThis repository contains the source files for the Synse platform's hosted documentation.\n\nThe documentation covers multiple projects:\n\n- [Synse Server](https://github.com/vapor-ware/synse-server)\n- [Synse SDK](https://github.com/vapor-ware/synse-sdk)\n- [Synse CLI](https://github.com/vapor-ware/synse-cli)\n\n## Structure\n\nAll project documentation is written in Markdown and is found in the [`docs`](docs)\nsubdirectory. All markdown files in the `docs` directory are for the documentation\n\"Home\" section.\n\nSubdirectories within the `docs` directory designate different sections of the documentation\ncorresponding to different Synse projects. For example, the [`docs/server`](docs/server)\ndirectory contains documentation for Synse Server.\n\nFor more information on writing and styling docs, see the [`mkdocs` documentation](https://www.mkdocs.org/).\n\n## Building\n\nThe documentation can be built locally, which can be helpful for writing and styling the docs.\n\n```\npoetry run mkdocs serve\n```\n\nThis will build the docs into a `site` directory and serve them on `http://127.0.0.1:8000`.\n\n## Releasing\n\nThis documentation is hosted on [Read the Docs](https://readthedocs.org/), so whenever a change is\npushed to a tracked branch, like master, it will get rebuilt and updated automatically.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvapor-ware%2Fsynse-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvapor-ware%2Fsynse-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvapor-ware%2Fsynse-docs/lists"}