kingchenc
57e52c67b9
* ci: add external link check (lychee, scheduled + on-demand) Adds a non-blocking external-link checker mirroring wickra-docs: an authoritative weekly + on-demand lychee run (this workflow), kept off the PR/release path so a flaky third-party site can never block a merge or an irreversible publish. Fixes the one redirecting link it would flag (docs.rs/wickra -> docs.rs/wickra/latest/wickra/ in SUPPORT.md). * ci: run lychee as a non-blocking PR job (continue-on-error) Hybrid link-check: the authoritative run is the scheduled links.yml; this adds an early heads-up on PRs that never gates the merge. release.yml stays ungated so a flaky third-party site can never block an irreversible publish.
38 lines
1.3 KiB
Markdown
38 lines
1.3 KiB
Markdown
# Support
|
|
|
|
Thanks for using Wickra! Here is where to get help, depending on what you need.
|
|
|
|
## Documentation first
|
|
|
|
Most questions are answered in the documentation:
|
|
|
|
- **Docs site:** <https://docs.wickra.org> — quickstarts for Rust, Python,
|
|
Node.js, WASM, C, C++, C#, Go, Java and R, a per-indicator reference, warmup periods, the
|
|
data layer, and an FAQ.
|
|
- **README:** <https://github.com/wickra-lib/wickra#readme> — installation and a
|
|
quick overview.
|
|
- **API docs (Rust):** <https://docs.rs/wickra/latest/wickra/>.
|
|
|
|
## Questions and help
|
|
|
|
- Ask a question with the
|
|
[question issue template](.github/ISSUE_TEMPLATE/question.md).
|
|
- Browse [existing issues](https://github.com/wickra-lib/wickra/issues) — your
|
|
question may already be answered.
|
|
|
|
## Bugs and feature requests
|
|
|
|
- **Bugs:** use the bug-report issue template.
|
|
- **Feature requests / new indicators:** use the feature-request template.
|
|
|
|
## Security issues
|
|
|
|
Please do **not** report security vulnerabilities through public issues. Follow
|
|
the process in [`SECURITY.md`](SECURITY.md) (private GitHub advisory or email).
|
|
|
|
## Support expectations
|
|
|
|
Wickra is maintained by a single maintainer on a best-effort basis. Issues are
|
|
triaged and acknowledged as time allows; there is no commercial support or SLA.
|
|
Clear, reproducible reports get help fastest.
|