MaddyUnderStars / MaddyUnderStars/shoot
gateway documentation
Open
Nobody has claimed this yet.
documentation
- Dominant language
- TypeScript
- Stars
- 61
- Forks
- 5
- Avg merge
- 3d 10h
- Merged PRs (30d)
- 1
Description
currently there is no documentation about the gateway opcodes/etc. the API side is pretty good I think, with an auto generated openapi spec. albeit, it could use some actually human written descriptions.
some options:
- apparently openapi v3 has a 'callbacks' concept which you can use to define webhooks. if I could stick with just openapi for the entire project, that'd be perfect
- AsyncAPI
- apparently that's it???
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No files, tests, or entry points are named. Start by locating the gateway opcode definitions and reviewing the existing generated OpenAPI coverage, then evaluate whether OpenAPI callbacks or AsyncAPI fits the gateway documentation. Done means the gateway opcodes and related behavior are documented in a chosen format.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, typescript
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100