Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README content missing from generated typedoc #1056

Open
dckc opened this issue Apr 3, 2024 · 2 comments
Open

README content missing from generated typedoc #1056

dckc opened this issue Apr 3, 2024 · 2 comments
Assignees
Labels
api-docs issues that generated api-docs should address bug

Comments

@dckc
Copy link
Member

dckc commented Apr 3, 2024

https://docs.agoric.com/reference/endo/modules/endo_captp is missing the README copy

A minimal CapTP implementation leveraging Agoric's published modules.
Usage
...

compare with https://endojs.github.io/endo/modules/_endo_captp.html

likewise all other packages in endo, agoric-sdk

@dckc dckc added api-docs issues that generated api-docs should address bug labels Apr 3, 2024
@dckc
Copy link
Member Author

dckc commented Apr 4, 2024

we are not alone:

This had been fixed, but only in the next version. (typedoc-plugin-markdown@next).

@dckc dckc self-assigned this Apr 4, 2024
@dckc
Copy link
Member Author

dckc commented Apr 9, 2024

using typedoc-plugin-markdown@next, I get README files, with no extension. :-/

If I rename to README.md, vitepress consumes them as expected. hm.

@dckc dckc changed the title generated typedoc lacks README content README content missing from generated typedoc Apr 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api-docs issues that generated api-docs should address bug
Projects
None yet
Development

No branches or pull requests

1 participant