Skip to content

Automate Markdown List Formatting and LLM Skill Generation#17

Merged
dgaida merged 2 commits into
masterfrom
fix/docs-llm-skill-5175681484165727838
May 16, 2026
Merged

Automate Markdown List Formatting and LLM Skill Generation#17
dgaida merged 2 commits into
masterfrom
fix/docs-llm-skill-5175681484165727838

Conversation

@dgaida
Copy link
Copy Markdown
Owner

@dgaida dgaida commented May 16, 2026

This PR implements automated improvements to the documentation workflow and adds a new 'Skill' file for LLMs.

Key changes:

  1. Markdown List Fixer: Created a utility script pyadm1/utils/fix_markdown_lists.py that 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.
  2. LLM Skill Generation: Created pyadm1/utils/generate_skill_md.py which extracts full docstrings for key classes and methods used in building simulation models. This generates a Skill.md file designed to be consumed by LLMs.
  3. CI/CD Integration: Updated .github/workflows/docs.yml to automatically run the list fixer and the skill generator during every documentation build.
  4. UI Updates: Added callouts to both English and German versions of the llm_api.md page providing a download link for the generated Skill.md file.

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

- 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>
@google-labs-jules
Copy link
Copy Markdown
Contributor

👋 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 @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

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>
@dgaida dgaida merged commit 9d8a668 into master May 16, 2026
7 checks passed
@dgaida dgaida deleted the fix/docs-llm-skill-5175681484165727838 branch May 16, 2026 18:05
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.

1 participant