Skip to content

docs: Improve cli overview - #2414

Merged
Sehat1137 merged 7 commits into
ag2ai:devfrom
borisalekseev:docs/faststream-cli
Aug 22, 2025
Merged

docs: Improve cli overview#2414
Sehat1137 merged 7 commits into
ag2ai:devfrom
borisalekseev:docs/faststream-cli

Conversation

@borisalekseev

@borisalekseev borisalekseev commented Aug 5, 2025 •
edited by Lancetnik
Loading

Copy link
Copy Markdown
Collaborator

Description

Please include a summary of the change and specify which issue is being addressed. Additionally, provide relevant motivation and context.

Fixes #508

Type of change

Please delete options that are not relevant.

  • Documentation (typos, code examples, or any documentation updates)
  • Bug fix (a non-breaking change that resolves an issue)
  • New feature (a non-breaking change that adds functionality)
  • Breaking change (a fix or feature that would disrupt existing functionality)
  • This change requires a documentation update

Checklist

  • My code adheres to the style guidelines of this project (scripts/lint.sh shows no errors)
  • I have conducted a self-review of my own code
  • I have made the necessary changes to the documentation
  • My changes do not generate any new warnings
  • I have added tests to validate the effectiveness of my fix or the functionality of my new feature
  • Both new and existing unit tests pass successfully on my local environment by running scripts/test-cov.sh
  • I have ensured that static analysis tests are passing by running scripts/static-analysis.sh
  • I have included code examples to illustrate the modifications

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Aug 5, 2025
@borisalekseev
borisalekseev marked this pull request as ready for review August 6, 2025 13:10
@Lancetnik
Lancetnik requested a review from Sehat1137 August 6, 2025 18:14
Sehat1137
Sehat1137 reviewed Aug 7, 2025
View reviewed changes

@Sehat1137 Sehat1137 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kumaranvpl can you please take a look?

Comment thread docs/docs/en/getting-started/asgi.md
Comment thread docs/docs/en/getting-started/cli/docs.md Outdated
Comment thread docs/docs/en/getting-started/cli/publish.md Outdated
Comment thread docs/docs/en/getting-started/cli/run.md Outdated
@borisalekseev
borisalekseev marked this pull request as draft August 12, 2025 20:58
@borisalekseev borisalekseev changed the title Improve cli overview in docs docs: Improve cli overview Aug 12, 2025
@borisalekseev
borisalekseev force-pushed the docs/faststream-cli branch 3 times, most recently from 24bf0b9 to adb96b4 Compare August 13, 2025 15:24
@borisalekseev
borisalekseev marked this pull request as ready for review August 13, 2025 15:25
@borisalekseev
borisalekseev marked this pull request as draft August 13, 2025 15:39
@borisalekseev
borisalekseev marked this pull request as ready for review August 13, 2025 16:01
@Lancetnik
Lancetnik changed the base branch from main to dev August 15, 2025 18:26
@borisalekseev
borisalekseev marked this pull request as draft August 17, 2025 20:23
@borisalekseev
borisalekseev marked this pull request as ready for review August 17, 2025 20:23
Sehat1137
Sehat1137 previously approved these changes Aug 20, 2025
View reviewed changes
@Sehat1137
Sehat1137 requested a review from draincoder as a code owner August 20, 2025 18:10
@github-actions github-actions Bot added Confluent Issues related to `faststream.confluent` module AioKafka Issues related to `faststream.kafka` module NATS Issues related to `faststream.nats` module and NATS broker features Observability labels Aug 20, 2025
@Sehat1137
Sehat1137 requested a review from Lancetnik as a code owner August 20, 2025 18:14
@Sehat1137
Update internal links to point to correct paths
78cb987 
Add new CLI documentation

Remove old CLI documentation files
@Sehat1137
fixes
5138084
@Sehat1137
Sehat1137 force-pushed the docs/faststream-cli branch from d9e9107 to 5138084 Compare August 20, 2025 18:17
Sehat1137
Sehat1137 previously approved these changes Aug 20, 2025
View reviewed changes
Sehat1137
Sehat1137 previously approved these changes Aug 22, 2025
View reviewed changes
@Sehat1137
Sehat1137 added this pull request to the merge queue Aug 22, 2025
Merged via the queue into ag2ai:dev with commit ee02131 Aug 22, 2025
27 checks passed
@Sehat1137
Sehat1137 deleted the docs/faststream-cli branch August 22, 2025 19:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Lancetnik Lancetnik Lancetnik approved these changes
@Sehat1137 Sehat1137 Sehat1137 left review comments
@kumaranvpl kumaranvpl Awaiting requested review from kumaranvpl
@draincoder draincoder Awaiting requested review from draincoder

Assignees

No one assigned

Labels

AioKafka Issues related to `faststream.kafka` module Confluent Issues related to `faststream.confluent` module documentation Improvements or additions to documentation NATS Issues related to `faststream.nats` module and NATS broker features Observability

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add CLI docs

3 participants

@borisalekseev @Sehat1137 @Lancetnik