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

fix: helia api docs have no blank pages #176

Closed
3 of 5 tasks
SgtPooki opened this issue Jul 6, 2023 · 11 comments · Fixed by #177 or #181
Closed
3 of 5 tasks

fix: helia api docs have no blank pages #176

SgtPooki opened this issue Jul 6, 2023 · 11 comments · Fixed by #177 or #181
Assignees

Comments

@SgtPooki
Copy link
Member

SgtPooki commented Jul 6, 2023

Goals

tsdoc generated documentation at https://ipfs.github.io/helia/ should present users with a more intuitive experience.

Tasks

@SgtPooki SgtPooki self-assigned this Jul 6, 2023
@SgtPooki SgtPooki linked a pull request Jul 6, 2023 that will close this issue
SgtPooki added a commit that referenced this issue Jul 6, 2023
whizzzkid pushed a commit that referenced this issue Jul 10, 2023
* fix: typedoc-plugin-mdn-links is available

* fix: typedoc landing page uses readme

fixes #176
@BigLep
Copy link
Contributor

BigLep commented Jul 10, 2023

@SgtPooki : I'm reopening because when I go to https://ipfs.github.io/helia/ , I still don't get a useful landing page.

@SgtPooki
Copy link
Member Author

re-opening just to confirm that ipfs.github.io/helia has the issue resolved.

@SgtPooki
Copy link
Member Author

@SgtPooki
Copy link
Member Author

we have a landing page now, and 404s are gone

@BigLep
Copy link
Contributor

BigLep commented Aug 9, 2023

I'm reopening because when I go to https://ipfs.github.io/helia/index.html, I don't actually see any "API docs" along the line of returnType functionName(argName). (I accept I am maybe blind here.)

@BigLep BigLep reopened this Aug 9, 2023
@SgtPooki
Copy link
Member Author

SgtPooki commented Aug 9, 2023

it appears that some changes were made at some point (@achingbrain ?)

@achingbrain
Copy link
Member

I updated to the latest version of TypeDoc. Very strange this, I get the API docs you'd expect when building them locally but it looks like not in CI?

@whizzzkid whizzzkid assigned whizzzkid and unassigned SgtPooki Aug 11, 2023
@achingbrain
Copy link
Member

This looks healthy again, although I'm still at a loss as to what upset TypeDoc so much as to cause the docs to disappear in the first place.

@achingbrain
Copy link
Member

Closing as the landing page for the API docs is no longer blank.

@whizzzkid
Copy link
Contributor

@achingbrain just to understand, this fixed itself? 🤔

@achingbrain
Copy link
Member

TypeDoc has been upgraded in Aegir, as modules are updated and their docs re-published, the blank pages will go away.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
4 participants