Skip to content

Conversation

@VascoSch92
Copy link
Contributor

  • I have read and reviewed the documentation changes to the best of my ability.
  • If the change is significant, I have run the documentation site locally and confirmed it renders as expected.

Summary of changes

This is a proposal for a new API generator using mkdocstrings (see issue #65).

The new script should be less prone to bugs because it involves a transition from MD to MDX—which are very similar—rather than converting from RST to MDX.

This is just an initial version, so please let me know what you think of the new format! It is very easy to adjust, so if you have any specific requests, I can easily implement them.

PS: I added a pyproject.toml to the project to streamline development. This might cause some conflicts with Mint, but I’ve added a .mintignore file to prevent any issues.

@VascoSch92 VascoSch92 added the documentation Improvements or additions to documentation label Feb 6, 2026
@openhands-ai
Copy link

openhands-ai bot commented Feb 9, 2026

Looks like there are a few issues preventing this PR from being merged!

  • GitHub Actions are failing:
    • .github/workflows/sync-agent-sdk-openapi.yml
    • .github/workflows/sync-docs-code-blocks.yml

If you'd like me to help, just leave a comment, like

@OpenHands please fix the failing actions on PR #305 at branch `api-docs-in-md`

Feel free to include any additional details that might help me get this PR into a better state.

You can manage your notification settings

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant