Welcome to the repository containing documentation of the Ktor framework, published on https://ktor.io/docs/.
This project is built with Writerside and has the following project structure:
/cfgcontains configuration files./codeSnippetscontains a Gradle project with runnable code samples demonstrating Ktor capabilities. To learn how to run the samples and reference them in topics, see the Code Snippets Doc./imagescontains images and GIFs used in topics./templateshas a singlesettings.zipfile containing IntelliJ IDE settings./topicscontains documentation files in Markdown and XML.ktor.treedefines the table of contents.c.listcontains a list of categories that define groups of related links for the 'See also' section of a topic.v.listcontains a list of global project variables.
We welcome and encourage various types of contributions to the Ktor Docs. If you'd like to contribute, but don't know where to start, take a look at the open issues on YouTrack.
You can find detailed information about contributing and submitting a pull request in our Contribution Guidelines.
If you find a bug in this repo or have a feature request that hasn't already been reported, we invite you to create a new issue on YouTrack or contribute to this repo.
At the bottom of each documentation page published on ktor.io/docs you will find a 'Was this page helpful?' prompt:
You have two options:
- Select Yes to automatically send us positive feedback.
- Select No to open and fill out a feedback form. Make sure to give as much detail as possible.
The Ktor team consistently reviews and addresses received feedback.
Thank you for being a part of our community 🧡! We appreciate your support and efforts towards improving Ktor and Ktor Documentation.
For any Ktor-related support questions, please use Stack Overflow. For peer to peer support, use the Ktor channel on Slack (request access).