Skip to content

Commit 34e7c94

Browse files
Clarify README
- Let's call it "guide" not "documentation" to be less ambiguous with the future API reference/our KDoc in general. - The commit also adds a link to the Analysis API's sources in the Kotlin repo, since some users may find the guide repository when they're looking for the Analysis API itself.
1 parent 354f226 commit 34e7c94

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
1-
# Kotlin Analysis API Documentation
1+
# Kotlin Analysis API Guide
22

33
[![official project](http://jb.gg/badges/official.svg)](https://confluence.jetbrains.com/display/ALL/JetBrains+on+GitHub)
44
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
55

6-
This repository contains documentation sources for the Kotlin Analysis API library.
7-
You might want to check the [generated documentation website](https://kotl.in/analysis-api).
6+
This repository contains documentation sources for the Kotlin Analysis API library. You might want to check the
7+
[Analysis API guide](https://kotl.in/analysis-api) which is generated from this repository.
8+
9+
The sources of the Analysis API itself live inside the [Kotlin language repository](https://github.com/JetBrains/kotlin/tree/master/analysis).
810

911
---
1012

11-
The Analysis API is a powerful library for analyzing code in Kotlin.
12-
Built on top of the Kotlin PSI syntax tree, it provides access to various semantic information, including reference
13-
targets, expression types, declaration scopes, diagnostics, and more.
13+
The Analysis API is a powerful library for analyzing code in Kotlin. Built on top of the Kotlin PSI syntax tree, it
14+
provides access to various semantic information, including reference targets, expression types, declaration scopes,
15+
diagnostics, and more.

0 commit comments

Comments
 (0)