Would it be possible to require and link documenta...

# ktor

[maxmello]

Would it be possible to require and link documentation of new features in release notes or the corresponding issues in YouTrack? The linked issues mostly describe some missing feature, but now its a whole separate process, after going through release notes, of finding out how to actually implement these new features. Or am I missing something?

[Aleksei Tirman [JB]]

Usually if the feature requires documentation, the corresponding documentation issue is linked in YouTrack. Is it enough or do you want to see such issues in the release notes too?

[maxmello]

Do documentation issues always correspond to some part of https://ktor.io/docs? If so, I think the most user-friendly thing would be to link to the part of the documentation there.
For example, this issue does not seem to link any documentation, correct? https://youtrack.jetbrains.com/issue/KTOR-5523
This issue does have some comments that describe the changes; I guess from my point of view I’m never sure if how it was once written as a comment is how it actually shipped. One comment also says “I’ll close it when documentation will be ready” but it is not really clear where this documentation was added https://youtrack.jetbrains.com/issue/KTOR-5265

The more I look into this, it appears that “Design for…” names issues are documentation issues? Is that the required naming convention?

[Aleksei Tirman [JB]]

For example, this issue does not seem to link any documentation, correct?

It's linked but the issue isn't visible for anyone. We can fix that.

[Aleksei Tirman [JB]]

So I think the best way would be to post the corresponding links to the documentation in the change log. What do you think?

[maxmello]

Ah I see - would it make a difference it I were to log in to YouTrack?
Sure, that would be great