kwila/market
1
0
Fork 1
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: add roadmap #13

Merged
Pertempto merged 11 commits from ae-add-roadmap into main 2025-11-08 06:00:44 -05:00
Conversation 2 Commits 11 Files changed 6 +324 -89
Pertempto commented 2025-11-06 07:37:16 -05:00 (Migrated from github.com)
Copy link

Updated architecture and added roadmap

Updated architecture and added roadmap
github-actions[bot] commented 2025-11-08 05:48:46 -05:00 (Migrated from github.com)
Copy link

ROADMAP.md — Under “Build signup flow” you still list: Add contact_info creation with primary contact.

  • Actionable: remove or update this line to reflect that contact_info.is_primary was removed (per ARCHITECTURE.md). If you want a single preferred contact, clarify the replacement (e.g., mark contact_info as preferred/verified or add user_settings key for preferred contact).
`ROADMAP.md` — Under “Build signup flow” you still list: `Add contact_info creation with primary contact`. - Actionable: remove or update this line to reflect that `contact_info.is_primary` was removed (per `ARCHITECTURE.md`). If you want a single preferred contact, clarify the replacement (e.g., `mark contact_info as preferred/verified` or add `user_settings` key for preferred contact).
github-actions[bot] commented 2025-11-08 05:49:02 -05:00 (Migrated from github.com)
Copy link

Changes Requested

  • Make the GitHub Actions run reproducible for contributors: remove or replace the private container image in .github/workflows/code-review.yml or make the image public; clarify the required repo secrets.
  • Align ROADMAP.md with ARCHITECTURE.md regarding contact_info.is_primary removal: update signup docs to state contact_info visibility or add a preferred_contact mechanism.
  • Add explicit index guidance or include 003_indexes.sql in migrations for item/items queries (database performance is important for listing pages).

Summary of Changes

  • Added GitHub Actions workflow for the code review bot at .github/workflows/code-review.yml.
  • Added documentation files/updates: AGENTS.md, ARCHITECTURE.md, ROADMAP.md, and README.md updates.
  • Significant schema and flow clarifications in ARCHITECTURE.md (singular table names, new item_image, message_image, watch, connection, thread tables, invite/onboarding flow updates).

Overall Feedback

  • Issues (needs changes): The workflow references a private container image ghcr.io/mrs-electronics-inc/bots/code-review:latest and a non-standard secret API_KEY_CODE_REVIEW_BOT. This will break CI for external contributors; switch to a public action or run the script directly on the runner. Also the ROADMAP.md still references creating contact info during signup without reflecting that is_primary was removed in ARCHITECTURE.md — reconcile these docs or add a replacement preferred_contact mechanism. Finally, consider adding index guidance or including 003_indexes.sql in migrations for item listing performance.

  • Positives: Documentation updates significantly clarify schema, visibility rules, and feature roadmap. The item_image and message_image breakdown and the watch list addition are good improvements. Nice, thorough work on architecture and roadmap. 🚀

# Changes Requested - Make the GitHub Actions run reproducible for contributors: remove or replace the private container image in `.github/workflows/code-review.yml` or make the image public; clarify the required repo secrets. - Align `ROADMAP.md` with `ARCHITECTURE.md` regarding `contact_info.is_primary` removal: update signup docs to state `contact_info` visibility or add a `preferred_contact` mechanism. - Add explicit index guidance or include `003_indexes.sql` in migrations for `item`/`items` queries (database performance is important for listing pages). ## Summary of Changes - Added GitHub Actions workflow for the code review bot at `.github/workflows/code-review.yml`. - Added documentation files/updates: `AGENTS.md`, `ARCHITECTURE.md`, `ROADMAP.md`, and `README.md` updates. - Significant schema and flow clarifications in `ARCHITECTURE.md` (singular table names, new `item_image`, `message_image`, `watch`, `connection`, `thread` tables, invite/onboarding flow updates). ## Overall Feedback - Issues (needs changes): The workflow references a private container image `ghcr.io/mrs-electronics-inc/bots/code-review:latest` and a non-standard secret `API_KEY_CODE_REVIEW_BOT`. This will break CI for external contributors; switch to a public action or run the script directly on the runner. Also the `ROADMAP.md` still references creating contact info during signup without reflecting that `is_primary` was removed in `ARCHITECTURE.md` — reconcile these docs or add a replacement `preferred_contact` mechanism. Finally, consider adding index guidance or including `003_indexes.sql` in migrations for item listing performance. - Positives: Documentation updates significantly clarify schema, visibility rules, and feature roadmap. The `item_image` and `message_image` breakdown and the watch list addition are good improvements. Nice, thorough work on architecture and roadmap. :rocket:
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
kwila/market!13
No description provided.