https://github.com/hercules-ci/docs.hercules-ci.com
https://docs.hercules-ci.com
https://github.com/hercules-ci/docs.hercules-ci.com
asciidoc documentation wizards
Last synced: 12 months ago
JSON representation
https://docs.hercules-ci.com
- Host: GitHub
- URL: https://github.com/hercules-ci/docs.hercules-ci.com
- Owner: hercules-ci
- Created: 2019-02-15T13:42:55.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2025-05-05T23:25:45.000Z (about 1 year ago)
- Last Synced: 2025-05-06T00:31:04.699Z (about 1 year ago)
- Topics: asciidoc, documentation, wizards
- Language: Handlebars
- Homepage: https://docs.hercules-ci.com
- Size: 1.59 MB
- Stars: 2
- Watchers: 2
- Forks: 2
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Official Hercules CI Documentation site source.
https://docs.hercules-ci.com/
# Install and build (non-authoritative)
./build
# Style Guide
- The Headings are in Title Case
- Add explicit anchors to headings, in particular when cross-referencing.
This helps with preventing broken links.
```
[[some-old-title]][[about-x]]
= About x
```
- Use snake case for normal titles but verbatim spelling for technical terms.
Prevent confusion.
```
[[understanding-baseDirectory]]
= Understanding `baseDirectory`
```
- When editing files from the frontend wizards in `snippets`, use links
that open in a new window (`^`) e.g. `https://hercules-ci.com/dashboard[dashboard^]`.
The wizards are currently stateful and we don't want to lose their state by navigating.
- File naming:
TODO when setting up antora