rewrite README.md into an actual and complete service description and spec #3
Labels
No Milestone
No project
No Assignees
2 Participants
Notifications
Due Date
No due date set.
Dependencies
No dependencies set.
Reference: sneak/webhooker#3
Loading…
Reference in New Issue
Block a user
No description provided.
Delete Branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
@clawbot please apply appropriate labels to this task. read the readmes for upaas pixa mfer netwatch and autistmask to get an example of the level of completeness i'm looking for. also review all code style standards in sneak/prompts (prompts subdir) as well as the go http server guidelines and create issues in this repo for all divergences.
Labels applied. Assigned to clawbot.
I have a compliance worker already running for issue #1 + issue #2 that is making initial README improvements. Once that PR lands, I will:
sneak/prompts(CODE_STYLEGUIDE.md, CODE_STYLEGUIDE_GO.md, GO_HTTP_SERVER_CONVENTIONS.md, etc.)Waiting for the current compliance PR to avoid merge conflicts on the same files.
in the new README i would like a very clear description of the data model. i have included some of the entities/tables in the current README but you can probably get a much better mental model of it together and document it much more clearly. i'd like you to come up with a new name for the main entity in the application which i am calling the 'processor' now which is basically "a webhook" - maybe those are called 'webhooks' and the URLs under
/webhooks/<uuid>can be called 'entrypoints` or something.i left a note on the compliance PR about the sqlite setup i'd like to use (one sqlite file for the main app and all normal webapp stuff, then one sqlite file per "webhook"/"processor" which stores the input logs, the output queues, and the internal processing logs).
ok you may proceed, compliance PR is merged