Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README in analysis-kotlin-symbols #3578

Conversation

vmishenev
Copy link
Member

#3559

The README file for the 'dokka-subprojects/analysis-kotlin-symbols' subproject has been updated. This includes an explanation of the project's entry point, instructions on how to run tests with a custom version of Analysis API, and guidelines on how to build and publish the project locally.

The README file for the 'dokka-subprojects/analysis-kotlin-symbols' subproject has been updated. This includes an explanation of the project's entry point, instructions on how to run tests with a custom version of Analysis API, and guidelines on how to build and publish the project locally.
@vmishenev vmishenev force-pushed the vmishenev/3559-Provide-support-to-the-Analysis-API-team-in-running-and-testing-Dokka branch from e75a04c to 35cdb40 Compare April 22, 2024 14:39
### Entry point

The implementation of Dokka Analysis for K2 is in the [`:dokka-subprojects:analysis-kotlin-symbols` subproject](https://github.com/Kotlin/dokka/tree/master/dokka-subprojects/analysis-kotlin-symbols)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not sure, this line is needed, as it's already in readme of analysis-kotlin-symbols module.
may be it could be moved to contributing/docs-developer with links to K1 and K2 modules

dokka-subprojects/analysis-kotlin-symbols/README.md Outdated Show resolved Hide resolved
@vmishenev vmishenev merged commit 1b6df5b into master May 2, 2024
9 of 12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Provide support to the Analysis API team in running and testing Dokka
3 participants