docs: overhaul library documentation #458

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Merged

polvalente merged 35 commits into elixir-grpc:master from sleipnir:ref/docs-by-livebook

Nov 7, 2025

Collaborator

sleipnir commented Nov 6, 2025 •

edited by polvalente

Loading

This PR improves the documentation as whole:

Groups modules in the ex_doc rendering
Moves the example repositories into Livebooks
Adds function groups to the GRPC.Stream module docs

Adriano Santos and others added 15 commits

May 9, 2025 23:29


          chore: release new version

781a7cc


          Merge remote-tracking branch 'upstream/master'

ce286dc


          merge

dae7deb


          Merge remote-tracking branch 'upstream/master'

9fe3c55


          Merge remote-tracking branch 'upstream/master'

2a76e93


          Merge remote-tracking branch 'upstream/master'

3af0153


          Merge remote-tracking branch 'upstream/master'

4feee64


          Merge remote-tracking branch 'upstream/master'

bae8b92


          Merge remote-tracking branch 'upstream/master'

0cfb96d


          bump 0.10.2 -> 0.11.0

db695ec


          merge with master


          Merge remote-tracking branch 'upstream/master'

4ba7367


          Merge remote-tracking branch 'upstream/master'

9886e91


          Merge remote-tracking branch 'upstream/master'

64353db


          docs: try more professional documentation

eff66da

sleipnir requested a review from polvalente

November 6, 2025 21:22

sleipnir added 2 commits

November 6, 2025 19:44


          formatting

1847b3b


          temporary remove warning as errors

0b22774

polvalente reviewed

View reviewed changes

.github/workflows/ci.yml Outdated Show resolved Hide resolved

polvalente reviewed

View reviewed changes

guides/advanced/load_balancing.md Outdated Show resolved Hide resolved

polvalente reviewed

View reviewed changes

guides/cheatsheets/streams.cheatmd Outdated Show resolved Hide resolved

polvalente reviewed

View reviewed changes

guides/getting_started/client.md Outdated Show resolved Hide resolved

polvalente reviewed

View reviewed changes

guides/getting_started/installation.md Outdated Show resolved Hide resolved

polvalente reviewed

View reviewed changes

guides/getting_started/installation.md Outdated Show resolved Hide resolved

polvalente reviewed

View reviewed changes

guides/getting_started/installation.md Outdated Show resolved Hide resolved

polvalente reviewed

View reviewed changes

guides/getting_started/introduction.md Outdated Show resolved Hide resolved

polvalente reviewed

View reviewed changes

guides/getting_started/quickstart.livemd Show resolved Hide resolved

polvalente reviewed

View reviewed changes

guides/getting_started/stream.livemd Show resolved Hide resolved

polvalente reviewed

View reviewed changes

lib/grpc/client/resolver/xds.ex Show resolved Hide resolved

polvalente reviewed

View reviewed changes

lib/grpc/server.ex Outdated Show resolved Hide resolved

polvalente reviewed

View reviewed changes

lib/grpc/stream.ex Outdated Show resolved Hide resolved

polvalente reviewed

View reviewed changes

lib/grpc/stream.ex Outdated Show resolved Hide resolved

polvalente reviewed

View reviewed changes

lib/grpc/stream.ex Outdated Show resolved Hide resolved

polvalente reviewed

View reviewed changes

lib/grpc/stub.ex Outdated Show resolved Hide resolved

polvalente reviewed

View reviewed changes

mix.exs Outdated Show resolved Hide resolved

polvalente reviewed

View reviewed changes

mix.exs Outdated Show resolved Hide resolved

polvalente reviewed

View reviewed changes

mix.exs Outdated Show resolved Hide resolved

sleipnir and others added 17 commits

November 6, 2025 22:40


          chore: remove deprecated annotation

d1ddad3


          Update guides/getting_started/client.md

7320a40

Co-authored-by: Paulo Valente <16843419+polvalente@users.noreply.github.com>


          Update guides/getting_started/installation.md

26c65c7

Co-authored-by: Paulo Valente <16843419+polvalente@users.noreply.github.com>


          Update guides/getting_started/installation.md

f391bcb

Co-authored-by: Paulo Valente <16843419+polvalente@users.noreply.github.com>


          Update guides/getting_started/installation.md

cc8f8ea

Co-authored-by: Paulo Valente <16843419+polvalente@users.noreply.github.com>


          Update guides/getting_started/introduction.md

0f9c190

Co-authored-by: Paulo Valente <16843419+polvalente@users.noreply.github.com>


          chore: adjustments after review

cef15e2


          Merge branch 'ref/docs-by-livebook' of https://github.com/sleipnir/grpc…

1edb822

… into ref/docs-by-livebook


          chore: added header

d62fed8


          Update lib/grpc/server.ex

c1d4cd5

Co-authored-by: Paulo Valente <16843419+polvalente@users.noreply.github.com>


          Update lib/grpc/stream.ex

6bdf749

Co-authored-by: Paulo Valente <16843419+polvalente@users.noreply.github.com>


          Update lib/grpc/stream.ex

89bd113

Co-authored-by: Paulo Valente <16843419+polvalente@users.noreply.github.com>


          doc: reduce

b05c4b6


          doc: added flush function

3c21011


          doc: rename :utility to :actions

565dca7


          Merge branch 'ref/docs-by-livebook' of https://github.com/sleipnir/grpc…

… into ref/docs-by-livebook


          docs: update and adjustments

0cbaacd

sleipnir requested a review from polvalente

November 7, 2025 02:21

polvalente approved these changes

View reviewed changes

polvalente changed the title ~~[Ref] Docs by livebook~~ docs: overhaul library documentation


          chore: remove subproject examples

d9f1f60

polvalente merged commit fde44f4 into elixir-grpc:master

7 checks passed

sleipnir deleted the ref/docs-by-livebook branch

November 7, 2025 11:55

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet