Нужно добавить хук на смену темы виджета Gurubase при изменении темы основной документации FastStream
Готовый пример кода для работы с mkdocs уже есть в репозитории Gurubase. Все ссылки – в описании Issue
https://github.com/airtai/faststream/issues/2110
upd: решено ✅
#documentation #faststream
Готовый пример кода для работы с mkdocs уже есть в репозитории Gurubase. Все ссылки – в описании Issue
https://github.com/airtai/faststream/issues/2110
upd: решено ✅
#documentation #faststream
GitHub
docs: toggle Gurubase widget theme with original documentation one · Issue #2110 · airtai/faststream
We should switch Gurubase widget theme accordingly to documentation preffered one. Gurubase has already written example how it should be implemented with mkdocs Gurubase/gurubase-widget#17 https://...
👍5
FastStream снова нужна ваша помощь. Текущая версия документации сильно разбита на фрагменты для того, чтобы их можно было инклудить в разные переводы документации.
Но от идеи с разными переводами отказались, поэтому текущие атомы, которые используются только в одном месте нужно заинлайнить прямо в место использования для повышения удоства работы с исходниками доки.
Файлов много – поэтому принимаются любые PR'ы на любое количетсво файлов) Насколько хватит усидчивости – столько и приносите😅 Проекту действительно нужна ваша помощь, какой бы дурацкой не выглядела задача😢
Подробности есть в описание Issue, а к нему прикреплен даже PR-образец, чтобы было понятно, что ожидается от контрибуторов. Спасибо за внимание!
#documentation #faststream
upd: уже 6 разных контрибуторов влились в движуху
https://github.com/airtai/faststream/issues/2109
Но от идеи с разными переводами отказались, поэтому текущие атомы, которые используются только в одном месте нужно заинлайнить прямо в место использования для повышения удоства работы с исходниками доки.
Файлов много – поэтому принимаются любые PR'ы на любое количетсво файлов) Насколько хватит усидчивости – столько и приносите😅 Проекту действительно нужна ваша помощь, какой бы дурацкой не выглядела задача😢
Подробности есть в описание Issue, а к нему прикреплен даже PR-образец, чтобы было понятно, что ожидается от контрибуторов. Спасибо за внимание!
#documentation #faststream
upd: уже 6 разных контрибуторов влились в движуху
https://github.com/airtai/faststream/issues/2109
GitHub
docs: inline docs/includes to pages itself · Issue #2109 · airtai/faststream
We have a lot of includes/ - https://github.com/airtai/faststream/tree/main/docs/includes files created to share them between different translations. But now, we don't plan to support multilang...
👍8🌚3🔥1
Еще одна небольшая правка по документации FastStream – нужно заменить использование f-строк в логировании в примерах кода документации. В Issue приведен конкретный пример, но нужно найти все такие места и исправить их.
https://github.com/airtai/faststream/issues/2122
#documentation #faststream
https://github.com/airtai/faststream/issues/2122
#documentation #faststream
GitHub
docs: replace f-string in logger usage · Issue #2122 · airtai/faststream
Some our documentation examples uses f-strings – eg https://faststream.airt.ai/latest/getting-started/serialization/examples/#__codelineno-11-23 We should replacte them to follow official logging u...
Нужно добавить примеры хостинга AsyncAPI приложения через ручную генерацию html и ASGI mount
https://github.com/ag2ai/faststream/issues/2163
#faststream #documentation
https://github.com/ag2ai/faststream/issues/2163
#faststream #documentation
GitHub
docs: add information about manual AsyncAPI hosting · Issue #2163 · ag2ai/faststream
For now, our AsyncAPI hosting documentation shows the examples with our CLI only We should add infomation about manual documentation hosting using AsyncAPI module public API https://github.com/ag2a...
👍3🌭3
https://github.com/ag2ai/faststream/issues/2180
Очень простой Issue на расширение документации об использовании RPC в FastStream. Нужно добавить примеры использования
#documentation #faststream
Очень простой Issue на расширение документации об использовании RPC в FastStream. Нужно добавить примеры использования
Response классов и того, как должен выглядить subscriber, способный ответить на сообщение#documentation #faststream
GitHub
docs: improve RPC section · Issue #2180 · ag2ai/faststream
Improve the RPC (and other brokers as well) documentation page – we should add information about how should subscriber looks like to response on messages. Also, we should add information about Repo...
🚀 New issue to wemake-services/django-modern-rest by @sobolevn
📝 Figure out why
See https://github.com/wemake-services/django-modern-rest/blob/7aa23316219d4226d7c49435f9b028130f8c5dbc/docs/conf.py#L98-L99
When
This does not seem right, because everything is configure: intersphinx, imports, etc.
• Links in the form of inline
<img width="721" height="115" alt="Image" src="https://github.com/user-attachments/assets/91a0e5ee-90de-4e04-ae52-58514cc275f4" />
• The link in the annotations is not generated
<img width="737" height="377" alt="Image" src="https://github.com/user-attachments/assets/9ab218c1-0153-45f4-836f-e2d2eaaec92b" />
#documentation #helpwanted #goodfirst_issue
sent via relator
📝 Figure out why
sphinx does not link HttpResponse as a return type (#153)See https://github.com/wemake-services/django-modern-rest/blob/7aa23316219d4226d7c49435f9b028130f8c5dbc/docs/conf.py#L98-L99
When
make -C docs clean html is generated without this line, sphinx produces:django-modern-rest/django_modern_rest/errors.py:docstring of django_modern_rest.errors.global_error_handler:1: WARNING: py:class reference target not found: django.http.response.HttpResponse [ref.class]
django-modern-rest/django_modern_rest/endpoint.py:docstring of django_modern_rest.endpoint.Endpoint.__call__:1: WARNING: py:class reference target not found: django.http.response.HttpResponse [ref.class]
django-modern-rest/django_modern_rest/endpoint.py:docstring of django_modern_rest.endpoint.Endpoint.handle_async_error:1: WARNING: py:class reference target not found: django.http.response.HttpResponse [ref.class]
django-modern-rest/django_modern_rest/endpoint.py:docstring of django_modern_rest.endpoint.Endpoint.handle_error:1: WARNING: py:class reference target not found: django.http.response.HttpResponse [ref.class]
This does not seem right, because everything is configure: intersphinx, imports, etc.
• Links in the form of inline
:class: roles are rendered correctly<img width="721" height="115" alt="Image" src="https://github.com/user-attachments/assets/91a0e5ee-90de-4e04-ae52-58514cc275f4" />
• The link in the annotations is not generated
<img width="737" height="377" alt="Image" src="https://github.com/user-attachments/assets/9ab218c1-0153-45f4-836f-e2d2eaaec92b" />
#documentation #helpwanted #goodfirst_issue
sent via relator
❤1