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

Improve API documentation + website links #2227

Open
4 of 5 tasks
sniok opened this issue Aug 2, 2024 · 3 comments
Open
4 of 5 tasks

Improve API documentation + website links #2227

sniok opened this issue Aug 2, 2024 · 3 comments
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation regression Bugs for things that used to work in previous releases.
Milestone

Comments

@sniok
Copy link
Contributor

sniok commented Aug 2, 2024

After updating typedoc, the format of the generated documentation has changed. See #2219

Things that need to be done after the upgrade:

  • Regenerate docs/api/
  • Automate docs generation(?)
  • Update website links to the API doc
  • Configure typedoc markdown plugin to improve representation in docusaurus

Blog:

@sniok sniok added this to the v0.26.0 milestone Aug 2, 2024
@sniok sniok added the documentation Improvements or additions to documentation label Aug 2, 2024
@illume
Copy link
Collaborator

illume commented Aug 11, 2024

The API links are currently 404 in our plugin guide.

https://headlamp.dev/docs/latest/development/plugins/functionality

Note, these links are broken from before typedocs have been updated. Haven't checked the new typedocs config. Maybe because the new website renders markdown/links differently?

@illume illume added bug Something isn't working regression Bugs for things that used to work in previous releases. labels Aug 11, 2024
@joaquimrocha joaquimrocha changed the title Improve API documentation Improve API documentation + website links Aug 13, 2024
@sniok
Copy link
Contributor Author

sniok commented Sep 10, 2024

Links were updated in #2247, docs generation is already automated in headlamp-website repo.

@joaquimrocha joaquimrocha self-assigned this Sep 17, 2024
@joaquimrocha
Copy link
Collaborator

This PR fixes the blog redirection: headlamp-k8s/headlamp-website#46

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation regression Bugs for things that used to work in previous releases.
Projects
Status: In Progress
Development

No branches or pull requests

3 participants