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.

Sign up for GitHub

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

Jump to bottom

API documentation lives on concrete WebSocket implementations rather than interfaces #319

Open
pdaoust opened this issue Jan 6, 2025 · 0 comments
Open

API documentation lives on concrete WebSocket implementations rather than interfaces #319

pdaoust opened this issue Jan 6, 2025 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@pdaoust
Copy link

pdaoust commented Jan 6, 2025

It seems like it'd make more sense to document the interfaces to the admin and app APIs, then let the concrete implementations inherit that documentation. May need a spike to see if this can be done with api-documenter.
@pdaoust pdaoust added this to Holochain Jan 6, 2025
@github-project-automation github-project-automation bot moved this to Backlog in Holochain Jan 6, 2025
@pdaoust pdaoust changed the title API documentation lives on concrete WebSocket implementations rather than interfaces [enhancement] API documentation lives on concrete WebSocket implementations rather than interfaces Jan 6, 2025
@pdaoust pdaoust added documentation Improvements or additions to documentation enhancement New feature or request labels Jan 6, 2025
@pdaoust pdaoust changed the title [enhancement] API documentation lives on concrete WebSocket implementations rather than interfaces API documentation lives on concrete WebSocket implementations rather than interfaces Jan 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
Holochain
Status: Backlog
Milestone
No milestone
Development

No branches or pull requests
1 participant
@pdaoust