Skip to content
New issue

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

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

Already on GitHub? # to your account

Add script to generate LLMs.txt for AI assistants #338

Merged
merged 23 commits into from
Feb 28, 2025

Conversation

devin-ai-integration[bot]
Copy link
Contributor

@devin-ai-integration devin-ai-integration bot commented Feb 28, 2025

Add script to generate LLMs.txt for AI assistants

This PR adds a Python script that consolidates tutorial content and API documentation into a single markdown file for AI assistants, and includes the generated LLMs.txt file.

Features

  • Converts Jupyter notebooks in docs/en/tutorial to markdown using 'uv run jupyter nbconvert'
  • Concatenates markdown files based on docs/en/_toc.yml order
  • Generates Python stub files for ommx package using 'uv run pyright --createstub ommx'
  • Combines tutorials and API stubs into single LLMs.txt file
  • Adds clear section headers to separate tutorial and API content
  • Uses standard Markdown formatting throughout

Testing

The script has been tested and successfully generates the LLMs.txt file with proper markdown formatting and content.

Notes

  • The script uses 'uv add --dev' for package installation
  • The generated LLMs.txt file is now included in this PR as requested

Link to Devin run: https://app.devin.ai/sessions/c635c187a5714eb4939bbfdbd7af9694
Requested by: t.teramura@j-ij.com

AIアシスタント用のLLMs.txt生成スクリプトの追加

このPRは、チュートリアルコンテンツとAPIドキュメントを単一のマークダウンファイルにまとめるPythonスクリプトを追加し、生成されたLLMs.txtファイルも含んでいます。

機能

  • 'uv run jupyter nbconvert'を使用してdocs/en/tutorialのJupyterノートブックをマークダウンに変換
  • docs/en/_toc.ymlの順序に基づいてマークダウンファイルを連結
  • 'uv run pyright --createstub ommx'を使用してommxパッケージのPythonスタブファイルを生成
  • チュートリアルとAPIスタブを単一のLLMs.txtファイルに結合
  • チュートリアルとAPIコンテンツを区別する明確なセクションヘッダーを追加
  • 標準的なマークダウン形式を使用

テスト

スクリプトはテスト済みで、適切なマークダウン形式とコンテンツを持つLLMs.txtファイルを正常に生成します。

注意点

  • スクリプトはパッケージのインストールに'uv add --dev'を使用
  • 要求通り、生成されたLLMs.txtファイルが今回のPRに含まれています

Devin実行リンク: https://app.devin.ai/sessions/c635c187a5714eb4939bbfdbd7af9694
依頼者: t.teramura@j-ij.com

Co-Authored-By: t.teramura@j-ij.com <t.teramura@j-ij.com>
Copy link
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add "(aside)" to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

Copy link

codspeed-hq bot commented Feb 28, 2025

CodSpeed Performance Report

Merging #338 will not alter performance

Comparing devin/1740711676-generate-llms-txt (5a7919c) with main (289e8a7)

Summary

✅ 10 untouched benchmarks

devin-ai-integration bot and others added 9 commits February 28, 2025 03:18
Co-Authored-By: t.teramura@j-ij.com <t.teramura@j-ij.com>
Co-Authored-By: t.teramura@j-ij.com <t.teramura@j-ij.com>
Co-Authored-By: t.teramura@j-ij.com <t.teramura@j-ij.com>
Co-Authored-By: t.teramura@j-ij.com <t.teramura@j-ij.com>
Co-Authored-By: t.teramura@j-ij.com <t.teramura@j-ij.com>
Co-Authored-By: t.teramura@j-ij.com <t.teramura@j-ij.com>
Co-Authored-By: t.teramura@j-ij.com <t.teramura@j-ij.com>
…tallation

Co-Authored-By: t.teramura@j-ij.com <t.teramura@j-ij.com>
Co-Authored-By: t.teramura@j-ij.com <t.teramura@j-ij.com>
devin-ai-integration bot and others added 4 commits February 28, 2025 04:22
…es and tables

Co-Authored-By: t.teramura@j-ij.com <t.teramura@j-ij.com>
Co-Authored-By: t.teramura@j-ij.com <t.teramura@j-ij.com>
Co-Authored-By: t.teramura@j-ij.com <t.teramura@j-ij.com>
devin-ai-integration bot and others added 3 commits February 28, 2025 08:53
…lify workflow

Co-Authored-By: t.teramura@j-ij.com <t.teramura@j-ij.com>
Co-Authored-By: t.teramura@j-ij.com <t.teramura@j-ij.com>
Co-Authored-By: t.teramura@j-ij.com <t.teramura@j-ij.com>
devin-ai-integration bot and others added 5 commits February 28, 2025 09:06
Co-Authored-By: t.teramura@j-ij.com <t.teramura@j-ij.com>
Co-Authored-By: t.teramura@j-ij.com <t.teramura@j-ij.com>
Co-Authored-By: t.teramura@j-ij.com <t.teramura@j-ij.com>
…files

Co-Authored-By: t.teramura@j-ij.com <t.teramura@j-ij.com>
Copy link
Member

@termoshtt termoshtt left a comment

Choose a reason for hiding this comment

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

LGTM

@termoshtt termoshtt merged commit 746b224 into main Feb 28, 2025
36 checks passed
@termoshtt termoshtt deleted the devin/1740711676-generate-llms-txt branch February 28, 2025 10:45
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant