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

Add documentation to public API #2777

Open
johnshaughnessy opened this issue Aug 3, 2020 · 0 comments
Open

Add documentation to public API #2777

johnshaughnessy opened this issue Aug 3, 2020 · 0 comments
Assignees
@johnshaughnessy
Labels
extensibility jira-hubs

Comments

@johnshaughnessy
Copy link
Contributor

johnshaughnessy commented Aug 3, 2020 •
edited by data-sync-user
Loading

The public API can create and list rooms. We will add more features to it, but need to figure out a flow that works well for documenting what can be done.

This should be a combination of the auto-generated docs that come from the graphql schema and hand-written explainers with examples so that it's easy for people to get up and running.

Will also need to decide where and how this documentation is published.

GraphQL WIP:
Hubs-Foundation/reticulum#388
Hubs-Foundation/reticulum#399

┆Issue is synchronized with this Jira Task
@johnshaughnessy johnshaughnessy added this to the Q3 Planned milestone Aug 3, 2020
@johnshaughnessy johnshaughnessy mentioned this issue Aug 3, 2020
Closed
5 tasks
@johnshaughnessy johnshaughnessy modified the milestones: Q3 Planned, Q3 Sprint 2 Aug 3, 2020
@johnshaughnessy johnshaughnessy self-assigned this Aug 3, 2020
@misslivirose misslivirose removed this from the Q3 Sprint 2 milestone Feb 17, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@johnshaughnessy johnshaughnessy

Labels
extensibility jira-hubs
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@johnshaughnessy @misslivirose