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

frontend: Update typedoc version #2222

Closed
wants to merge 1 commit into from
Closed

frontend: Update typedoc version #2222

wants to merge 1 commit into from

Conversation

sniok
Copy link
Contributor

@sniok sniok commented Jul 31, 2024

Required for new typescript version #2219

The latest typedoc and markdown have some breaking changes resulting in a different file format. It's a bit easier to navigate than the current one but still not the best. There's some work needed to make the API docs more approachable.

Testing done:

  • Generated new API docs and previewed them in the headlamp website

Actions needed after this:

  • Update links in the documentation that point to any page in API (since folder structure is different now)
  • Explore more options/plugins for typedoc to make API reference more approachable

For now I'm keeping the current generated API docs as is

Signed-off-by: Oleksandr Dubenko <oldubenko@microsoft.com>
@sniok
Copy link
Contributor Author

sniok commented Jul 31, 2024

This was originally in different PR but It's not building without new typescript version, Moving this back into typescript version bump PR

@sniok sniok closed this Jul 31, 2024
@sniok sniok deleted the typedoc-upgrade branch July 31, 2024 09:00
@joaquimrocha joaquimrocha added this to the v0.25.1 milestone Sep 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

2 participants