From 65be43dbf59b6f815efec51a972dfe31977a4382 Mon Sep 17 00:00:00 2001 From: fryorcraken Date: Mon, 9 Jun 2025 18:56:41 +1000 Subject: [PATCH] add forum FURPS --- FURPS/application/forum.md | 41 ++++++++++++++ .../formalize_and_expand_waku_web_apps.md | 55 ++++++++++++++++++- 2 files changed, 93 insertions(+), 3 deletions(-) create mode 100644 FURPS/application/forum.md diff --git a/FURPS/application/forum.md b/FURPS/application/forum.md new file mode 100644 index 0000000..3e91974 --- /dev/null +++ b/FURPS/application/forum.md @@ -0,0 +1,41 @@ +# Waku Forum FURPS + +## Functionality + +1. Users identify themselves by signing with their Bitcoin key +2. Only users owning Logos ordinal can participate; usage of a centralized API to get current Logos ordinal owners may be needed. +3. Any user (authenticated or not) can see the content; basic encryption functionality +4. Existing cells can be listed +5. Cell can be created with a name, description, icon; icon size will be restricted; created is solo admin +6. Post can be created in a cell with a title and body; text only +7. Comments can be made on posts and other comments; text only +8. Posts can be upvoted +9. Users can setup a call sign; bitcoin identity operator unique name - remains - ordinal used as avatar; OP number out-of-scope (not onchain) +10. Cell admin can mark posts and comments as moderated +11. Cell admin can mark users as moderated + +## Usability + +1. A user can see all topics through all cells +2. A user can see the number of active members per cell; deduced from retrievable activity +3. Users can bookmark posts and topics; local only +4. Users can sort topics per new or top +5. The ordinal picture and information are used to identify user, in addition to the custom nickname +6. Moderated users, comments, and posts are hidden +7. Users do not need to sign every message with their wallet +8. Users do not need any software beyond a Bitcoin wallet browser extension +9. This includes a prototype UI to dogfood the PoC; Nice UI will be handled by Comms Hubs team +10. A library with clear API is produced to enable frontend developers to use it with a nice UI + +## Reliability + +1. Data is ephemeral; and will disappear after some time; No effort spent on topic or comment durability, out of scope for now. +2. End-to-end reliability strategy will be employed to enable app instance to know about missing messages and attempt to retrieve them. + +## Performance + +None + +## Supportability + +1. Web app with Bitcoin wallet browser extension \ No newline at end of file diff --git a/draft-roadmap/formalize_and_expand_waku_web_apps.md b/draft-roadmap/formalize_and_expand_waku_web_apps.md index 0982274..33f5b40 100644 --- a/draft-roadmap/formalize_and_expand_waku_web_apps.md +++ b/draft-roadmap/formalize_and_expand_waku_web_apps.md @@ -1,4 +1,4 @@ -# Formalize and Expand Waku Web Apps +# Logos Web Apps **Estimated date of completion**: 19 Dec 2025 @@ -21,10 +21,40 @@ to build over Waku. **Deliverables**: -## [Codex for message archival PoC](https://github.com/waku-org/pm/issues/293) +## [Forum PoC](https://github.com/waku-org/pm/issues/292) + +**Owner**: App/Chat Dev + +**Feature**: [Waku Forum](/FURPS/application/forum.md) + +**FURPS**: +- F1-11 +- U1-10 +- R1-2 + +**Checklist**: +- [ ] Specs: link to specs and/or API definition +- [ ] Code: link to GitHub issues/PRs/Epic +- [ ] Dogfood: link to dogfooding session/artefact +- [ ] Docs: links to README.md or docs.waku.org (TBD) + +## [Codex for Message Archival PoC](https://github.com/waku-org/pm/issues/293) TODO +**Owner**: {one waku subteam} + +**Feature**: [{Feature Name (only 1)}]({path/to/furps/file}) + +**FURPS**: +- {F1. copy-paste full furps statement} + +**Checklist**: +- [ ] Specs: link to specs and/or API definition +- [ ] Code: link to GitHub issues/PRs/Epic +- [ ] Dogfood: link to dogfooding session/artefact +- [ ] Docs: links to README.md or docs.waku.org (TBD) + ## [Reliable Qaku & library](https://github.com/waku-org/pm/issues/287) **Owner**: App/Chat Dev @@ -79,4 +109,23 @@ TODO - [ ] Code: link to GitHub issues/PRs/Epic - [ ] Dogfood: link to dogfooding session/artefact - ~[ ] Docs: links to README.md or docs.waku.org (TBD)~ -- [ ] Promote the app \ No newline at end of file +- [ ] Promote the app + +## Expand Waku Forum MVP + +TODO + +**Owner**: App/Chat Dev + +**Feature**: [Waku Forum](/FURPS/application/forum.md) + +**FURPS**: +- F1-11 +- U1-10 +- R1-2 + +**Checklist**: +- [ ] Specs: link to specs and/or API definition +- [ ] Code: link to GitHub issues/PRs/Epic +- [ ] Dogfood: link to dogfooding session/artefact +- [ ] Docs: links to README.md or docs.waku.org (TBD) \ No newline at end of file