Our Cursorless api docs have been a bit of a nightmare to maintain, and don't seem to be used by any maintainers. I believe the fundamental problem is that typedoc is designed to be used for public-facing apis, but we're using it to document internal APIs. That leads to us having to use some strange flags, so we're constantly fighting with the typedoc library as it gets updated
At the point where Cursorless publishes npm packages, such as the engine, we should revisit, but we'd probably use a more standard typedoc setup where we just document our public-facing api.
Our Cursorless api docs have been a bit of a nightmare to maintain, and don't seem to be used by any maintainers. I believe the fundamental problem is that typedoc is designed to be used for public-facing apis, but we're using it to document internal APIs. That leads to us having to use some strange flags, so we're constantly fighting with the typedoc library as it gets updated
At the point where Cursorless publishes npm packages, such as the engine, we should revisit, but we'd probably use a more standard typedoc setup where we just document our public-facing api.
@linkreferences in docstrings #601 as not plannedtypedocpnpm dependencies