Skip to content

Commit 47d3088

Browse files
committed
docs: link the unreleased docs from the README and release notes
1 parent 77c2865 commit 47d3088

2 files changed

Lines changed: 6 additions & 0 deletions

File tree

‎.github/changelog/cliff-release.toml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,10 @@ body = """
3535
[#{{ contributor.pr_number }}]({{ self::remote_url() }}/pull/{{ contributor.pr_number }}) \
3636
{%- endif %}
3737
{%- endfor %}\n
38+
39+
## Documentation
40+
- [jrtc.dev](https://jrtc.dev) describes this release
41+
- [jrtc.dev/next](https://jrtc.dev/next/) describes the main branch, with what is not released yet
3842
"""
3943
# A Tera template to be rendered as the changelog's footer.
4044
# See https://keats.github.io/tera/docs/#introduction

‎README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
[![Build Status](https://img.shields.io/github/actions/workflow/status/devopvoid/webrtc-java/build.yml?label=Build&logo=github)](https://github.com/devopvoid/webrtc-java/actions)
22
[![Maven Central](https://img.shields.io/maven-central/v/dev.onvoid.webrtc/webrtc-java?label=Maven%20Central&logo=apache-maven)](https://search.maven.org/artifact/dev.onvoid.webrtc/webrtc-java)
3+
[![Docs](https://img.shields.io/badge/Docs-unreleased-orange)](https://jrtc.dev/next/)
34

45
<p align="center">
56
<img alt="webrtc-java" width="100px" src="https://jrtc.dev/logo.png" />
@@ -40,6 +41,7 @@ For more detailed information, check out the documentation:
4041
- [Encoded Transforms](https://jrtc.dev/guide/advanced/encoded-transforms) - Reading and changing encoded frames, e.g. for end-to-end encryption
4142
- [Video Codecs](https://jrtc.dev/guide/advanced/video-codecs) - Adding video codecs implemented in Java, or limiting the built-in ones
4243
- [Build Notes](https://jrtc.dev/guide/build) - Instructions for building the library from source
44+
- [Unreleased Docs](https://jrtc.dev/next/) - Documentation of the main branch, including features not released yet
4345

4446
## License
4547

0 commit comments

Comments
 (0)