Skip to content

[Docs Bug 🐞 report]: Outdated info about code generation on the docs #5150

@AdnanAftab1

Description

@AdnanAftab1

Documentation Issue: Outdated generate-code Tutorial

Description

The tutorial at:
https://www.asyncapi.com/docs/tutorials/generate-code

does not reflect the current CLI behavior and recommended workflow for v3.


Issues Observed

  1. The tutorial references commands like:

    asyncapi new glee ...

    However, this does not align with the current recommended workflow using:

    asyncapi generate fromTemplate
  2. The generated project structure does not match the structure described in the tutorial.

  3. The “create new file” fallback does not produce the expected file layout shown in the documentation.


Expected Behavior

  • The tutorial should reflect the current CLI commands.
  • The generated project structure should match what is documented.
  • Deprecated or older workflows should either be updated or clearly marked.

Suggestion

  • Update the tutorial to use the modern generate fromTemplate workflow.
  • Ensure examples match the current CLI output.
  • Add a note clarifying version compatibility if needed.

Attach any resources that can help us understand the issue.

The current response for the stated set of commands in the tutorials ,which seems to be depreceated.

PS C:\Users\adnan\Music\OpenSource\trial> asyncapi new glee --name=tutorial --template=tutorial
 »   Warning: new glee is not a asyncapi command.
│
◇  Did you mean new file? [y/n]
│  No
 »   Error: Run asyncapi --help new for a list of available commands.
PS C:\Users\adnan\Music\OpenSource\trial> asyncapi --help new
Create a new AsyncAPI project, specification files, or templates for clients and applications.

USAGE
  $ asyncapi new

DESCRIPTION
  Create a new AsyncAPI project, specification files, or templates for clients and applications.

COMMANDS
  new file      Creates a new asyncapi file
  new template  Creates a new template

Code of Conduct

  • I agree to follow this project's Code of Conduct

Are you willing to work on this issue ?

Yes I am willing to submit a PR!

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    Status

    To Be Triaged

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions