Increase details of Channels documentation #236
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
julianbrost
requested changes
Jul 12, 2024
oxzi
force-pushed
the
docs-10-Channels-details
branch
from
84fa53b to
18cfa4d
Compare
oxzi
force-pushed
the
docs-10-Channels-details
branch
from
18cfa4d to
e4e6837
Compare
yhabteab
reviewed
Jul 12, 2024
oxzi
force-pushed
the
docs-10-Channels-details
branch
from
e4e6837 to
17cb89f
Compare
oxzi
force-pushed
the
docs-10-Channels-details
branch
from
17cb89f to
d021ef1
Compare
martialblog
reviewed
Jul 15, 2024
oxzi
force-pushed
the
docs-10-Channels-details
branch
from
d021ef1 to
f2f3ca7
Compare
oxzi
force-pushed
the
docs-10-Channels-details
branch
3 times, most recently
from
6fbc306 to
a88356d
Compare
oxzi
force-pushed
the
docs-10-Channels-details
branch
from
a88356d to
80f5cb5
Compare
oxzi
force-pushed
the
docs-10-Channels-details
branch
from
80f5cb5 to
2930520
Compare
|
I reworked some parts, especially to mention changes from #206. Furthermore, I described how the channel configuration through the two RPC methods works and how a channel plugin is expected to behave. As the documentation links to the Go API doc, I added more API docs for the fields. Please take another look. |
yhabteab
reviewed
Jul 16, 2024
oxzi
force-pushed
the
docs-10-Channels-details
branch
from
2930520 to
e833633
Compare
With a release approaching, the Channels documentation got more information about how the Channel system actually work and how to build your own channels. The internal/changes/examples JSON files were inlined to ease the readability and updated, as they contained partially outdated information. For the pkg/plugin part, some API documentation was added as this might get used by external users.
oxzi
force-pushed
the
docs-10-Channels-details
branch
from
e833633 to
42ad233
Compare
julianbrost
approved these changes
Jul 17, 2024
|
@martialblog Do you want to have another look as well, i.e. should I wait with merging this a bit? |
|
@julianbrost Thanks, I was away these last days. If I find something I'll just open a PR. Looking forward to v0.1.0 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
With a release approaching, the Channels documentation got more information about how the Channel system actually work and how to build your own channels.
The internal/changes/examples JSON files were inlined to ease the readability and updated, as they contained partially outdated information.
For the pkg/plugin part, some API documentation was added as this might get used by external users.