https://github.com/vapor-ware/synse-docs
Hosted documentation for Synse projects
https://github.com/vapor-ware/synse-docs
documentation synse
Last synced: 2 months ago
JSON representation
Hosted documentation for Synse projects
- Host: GitHub
- URL: https://github.com/vapor-ware/synse-docs
- Owner: vapor-ware
- License: gpl-3.0
- Created: 2019-05-14T19:55:52.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-09-28T20:25:46.000Z (over 1 year ago)
- Last Synced: 2025-03-21T22:03:10.330Z (3 months ago)
- Topics: documentation, synse
- Language: Groovy
- Homepage: https://synse.readthedocs.io
- Size: 591 KB
- Stars: 0
- Watchers: 10
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Synse Docs
This repository contains the source files for the Synse platform's hosted documentation.
The documentation covers multiple projects:
- [Synse Server](https://github.com/vapor-ware/synse-server)
- [Synse SDK](https://github.com/vapor-ware/synse-sdk)
- [Synse CLI](https://github.com/vapor-ware/synse-cli)
## Structure
All project documentation is written in Markdown and is found in the [`docs`](docs)
subdirectory. All markdown files in the `docs` directory are for the documentation
"Home" section.
Subdirectories within the `docs` directory designate different sections of the documentation
corresponding to different Synse projects. For example, the [`docs/server`](docs/server)
directory contains documentation for Synse Server.
For more information on writing and styling docs, see the [`mkdocs` documentation](https://www.mkdocs.org/).
## Building
The documentation can be built locally, which can be helpful for writing and styling the docs.
```
poetry run mkdocs serve
```
This will build the docs into a `site` directory and serve them on `http://127.0.0.1:8000`.
## Releasing
This documentation is hosted on [Read the Docs](https://readthedocs.org/), so whenever a change is
pushed to a tracked branch, like master, it will get rebuilt and updated automatically.