Skip to content

Koog Docs with Knit #542

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

Merged
merged 18 commits into from
Aug 8, 2025
Merged

Koog Docs with Knit #542

merged 18 commits into from
Aug 8, 2025

Conversation

tiginamaria
Copy link
Collaborator

@tiginamaria tiginamaria commented Aug 5, 2025

This PR brings the following changes:

  1. Move koog docs from private repo
  2. Add knit to assure compilation of code snippets from docs
  3. Add CI workflow to run knit before merging to main
  4. Add instructions on how to add knit annotations to docs and docs publication workflow

! The docs/docs changes are already reviewed by tech writers, please take a look into knit integration only and execution (CI) only
! The CI is tested on current branch, check https://github.com/JetBrains/koog/actions/runs/16755658514/job/47437479580
! I'm ready to change docs publication from this repo, but I can not do it right now as gh-pages have outdated docs from main branch


Type of the change

  • New feature
  • Bug fix
  • Documentation fix
  • Tests improvement

Checklist for all pull requests

  • The pull request has a description of the proposed change
  • I read the Contributing Guidelines before opening the pull request
  • The pull request uses develop as the base branch
  • Tests for the changes have been added
  • All new and existing tests passed
Additional steps for pull requests adding a new feature
  • An issue describing the proposed change exists
  • The pull request includes a link to the issue
  • The change was discussed and approved in the issue
  • Docs have been added / updated

Copy link

github-actions bot commented Aug 5, 2025

Qodana for JVM

387 new problems were found

Inspection name Severity Problems
Check Kotlin and Java source code coverage 🔶 Warning 382
Vulnerable imported dependency 🔶 Warning 4
String concatenation that can be converted to string template ◽️ Notice 1
@@ Code coverage @@
+ 68% total lines covered
8831 lines analyzed, 6024 lines covered
# Calculated according to the filters of your coverage tool

☁️ View the detailed Qodana report

Contact Qodana team

Contact us at [email protected]

@tiginamaria tiginamaria changed the base branch from develop to main August 5, 2025 16:49
@tiginamaria tiginamaria changed the base branch from main to develop August 5, 2025 16:49
Copy link
Member

@sproshev sproshev left a comment

Choose a reason for hiding this comment

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

thank you!

Copy link
Contributor

@devcrocod devcrocod left a comment

Choose a reason for hiding this comment

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

lgtm

I would use includeBuild("docs") to exclude the docs from the main build

@tiginamaria tiginamaria merged commit 090c70d into develop Aug 8, 2025
7 checks passed
@tiginamaria tiginamaria deleted the tigina/docs branch August 8, 2025 12:54
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.

3 participants