Would LiveDoc be useful for keeping CLDK documentation in sync with API changes?

[baksvell]

Pre-submission Checklist

• I have verified that this discussion would not be more appropriate as an issue in a specific repository
• I have searched existing discussions to avoid duplicates

Discussion Topic

Hi! I’m building an open-source developer tool called LiveDoc that helps detect documentation that may become outdated after code/API changes.

I’ve recently completed an initial real-world validation on three external Python/TypeScript repositories. During that testing, one project exposed a compatibility issue with Python @overload; I fixed it and released the fix in LiveDoc 0.3.2.

CLDK caught my attention because it has an evolving typed Python API and separate documentation, so it looks like an interesting real-world use case for LiveDoc.

I’d like to try LiveDoc against the CLDK repository and share the results here. You wouldn’t need to install anything or make any changes on your side.

At this stage I’m mainly trying to understand whether this kind of signal is actually useful to maintainers, so critical feedback would be very welcome.

LiveDoc: https://github.com/baksvell/Livedoc