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

Add hook for documentation #137

Open
dangunter opened this issue Sep 26, 2024 · 0 comments
Open

Add hook for documentation #137

dangunter opened this issue Sep 26, 2024 · 0 comments
Assignees
Labels
Discussion documentation Improvements or additions to documentation

Comments

@dangunter
Copy link
Collaborator

dangunter commented Sep 26, 2024

Currently we provide a hook to provide a diagram

We could also provide a hook to add description in text. This could include:

  • [required] main description text
  • [optional] link to page in watertap docs (could be specified as a relative path from technical reference root, or perhaps by an id)
  • [optional] other URLs for references, related software, etc. {name: (url, description)}
@dangunter dangunter added documentation Improvements or additions to documentation Discussion labels Sep 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Discussion documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants