Docs should be written during development and accompany PRs when relevant. There are multiple types of documentation, and different places to add each.
Developer services documentationedit
Documentation about specific services a plugin offers should be encapsulated in:
- README.asciidoc at the base of the plugin folder.
- Typescript comments for all public services.
End user documentationedit
Documentation about user facing features should be written in asciidoc at https://github.com/elastic/kibana/tree/master/docs
To build the docs, you must clone the elastic/docs repo as a sibling of your Kibana repo. Follow the instructions in that project’s README for getting the docs tooling set up.
To build the docs:
node scripts/docs.js --open
REST APIs should be documented using the following recommended formats:
General developer documentation and guidelinesedit
General developer guildlines and documentation, like this right here, should be written in asciidoc at https://github.com/elastic/kibana/tree/master/docs/developer