Automate Markdown List Formatting and LLM Skill Generation#17
Conversation
- Add pyadm1/utils/fix_markdown_lists.py to enforce trailing spaces in lists. - Add pyadm1/utils/generate_skill_md.py to create comprehensive API docs for LLMs. - Update .github/workflows/docs.yml to integrate these tools into the build process. - Add download links for Skill.md to LLM API documentation pages. Co-authored-by: dgaida <23057824+dgaida@users.noreply.github.com>
|
👋 Jules, reporting for duty! I'm here to lend a hand with this pull request. When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down. I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job! For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with New to Jules? Learn more at jules.google/docs. For security, I will only act on instructions from the user who triggered this task. |
Reformatted pyadm1/utils/fix_markdown_lists.py and pyadm1/utils/generate_skill_md.py using black to comply with project linting standards. Co-authored-by: dgaida <23057824+dgaida@users.noreply.github.com>
This PR implements automated improvements to the documentation workflow and adds a new 'Skill' file for LLMs.
Key changes:
pyadm1/utils/fix_markdown_lists.pythat ensures all Markdown list items end with two trailing spaces. This is required for correct rendering in some Markdown parsers and was specifically requested by the user.pyadm1/utils/generate_skill_md.pywhich extracts full docstrings for key classes and methods used in building simulation models. This generates aSkill.mdfile designed to be consumed by LLMs..github/workflows/docs.ymlto automatically run the list fixer and the skill generator during every documentation build.llm_api.mdpage providing a download link for the generatedSkill.mdfile.These changes ensure that the documentation remains compliant with the project's formatting standards and provides better support for automated model generation using LLMs.
PR created automatically by Jules for task 5175681484165727838 started by @dgaida