asyncapi / asyncapi/website

Docs Feedback: Migrated from discussions

Open
#5,550 0 comments 0 reactions 0 assignees View on GitHub
📑 docs
Dominant language
TypeScript
Stars
716
Forks
1.2k
Avg merge
1d 12h
Merged PRs (30d)
35

Description

## Migrated docs feedback from GitHub Discussions

These 14 discussions remain open from the old website feedback form (see #5330). They are migrated here for tracking under the docs feedback epic #5548.

Maintainers can update the **Completed**, **Assignee**, and **Notes** columns as items are triaged and worked on.

| # | Discussion | Feedback | Completed | Assignee | Notes |
|---|------------|----------|:---------:|----------|-------|
| 1 | [#1646](https://github.com/orgs/asyncapi/discussions/1646) | The very last link on this page is dead https://www.asyncapi.com/docs/reference/specification/#traitsMergeMechanism . You might want to change it to something like https://www.asyncapi.com/docs/reference/specification/v3.0.0#traits-merge-mechanism ; ) | - [ ] | | |
| 2 | [#2050](https://github.com/orgs/asyncapi/discussions/2050) | Want a Java example | - [ ] | | |
| 3 | [#2063](https://github.com/orgs/asyncapi/discussions/2063) | Can you define an operation in another file and then reference it? | - [ ] | | |
| 4 | [#2086](https://github.com/orgs/asyncapi/discussions/2086) | in kafka, we have the concept of an event key, payload, and headers. Using asyncapi, we are missing the key concept. | - [ ] | | |
| 5 | [#2230](https://github.com/orgs/asyncapi/discussions/2230) | i created asyncapi.yml, where should I add it in the project? | - [ ] | | |
| 6 | [#2234](https://github.com/orgs/asyncapi/discussions/2234) | the params object is not typed, I couldn't find it | - [ ] | | |
| 7 | [#2270](https://github.com/orgs/asyncapi/discussions/2270) | Why is there no content to read on any of the pages? | - [ ] | | |
| 8 | [#2271](https://github.com/orgs/asyncapi/discussions/2271) | Why is there no content to read on any of the pages? | - [ ] | | |
| 9 | [#2293](https://github.com/orgs/asyncapi/discussions/2293) | HOw to get a list of available template versions? | - [ ] | | |
| 10 | [#2316](https://github.com/orgs/asyncapi/discussions/2316) | Not helpful at all. I came here to learn how to get started, and you show me dead code, instead of explaining it. | - [ ] | | |
| 11 | [#2317](https://github.com/orgs/asyncapi/discussions/2317) | Not helpful at all. I came here to learn how to get started, and you show me dead code, instead of explaining it. | - [ ] | | |
| 12 | [#2318](https://github.com/orgs/asyncapi/discussions/2318) | After reading the entire getting started section, i DO NOT know how to actually get started. | - [ ] | | |
| 13 | [#2321](https://github.com/orgs/asyncapi/discussions/2321) | Doc is hard to understant and doe not explicilty list what is supported and what isn't | - [ ] | | |
| 14 | [#2331](https://github.com/orgs/asyncapi/discussions/2331) | the remember box: Consumers can also be producers | - [ ] | | |

Contributor guide

Open the contributing guide

Research direction

Start with the docs feedback epic #5548 and review the 14 linked Discussions listed in this issue, since each item describes a different concern. Triage each discussion, then update the Completed, Assignee, and Notes columns; done means every feedback item has been addressed or clearly recorded for follow-up.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, kafka, nextjs, react, tailwindcss, typescript
Domain
content, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.