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

docs: refinements #14

Merged
Pertempto merged 8 commits from 2025-11-08 into main 2025-11-08 20:22:26 -05:00
Conversation 2 Commits 8 Files changed 8 +266 -47
Pertempto commented 2025-11-08 20:06:53 -05:00 (Migrated from github.com)
Copy link

Greatly refine and reorganize the existing docs.

Added opencode commands.

Greatly refine and reorganize the existing docs. Added opencode commands.
github-actions[bot] commented 2025-11-08 20:09:38 -05:00 (Migrated from github.com)
Copy link

Changes Requested

Please make the following changes before merging:

  • .opencode/command/do-pr.md: add explicit, configurable non-interactive test command variables (e.g. TEST_CMD, TEST_UNIT_CMD, TEST_E2E_CMD, SINGLE_TEST_CMD) with repository-default values and update any hardcoded examples (CHANGELOG link) to point to https://github.com/kwila-cloud/market/pull/NN or use a repo variable.
  • AGENTS.md: restore a minimal "Agent quick commands" section with exact non-interactive commands (install, unit test, e2e test, single test, docker dev start, build) or clearly point to CONTRIBUTING.md while still providing those concrete commands.
  • README.md: replace the non-standard admonition > [!NOTE] with a standard GitHub blockquote (single >), or confirm you intentionally want the current syntax and why it should be preserved.

Please confirm the canonical package manager and exact test script names for this repo (e.g. pnpm install, pnpm test, pnpm test:unit, pnpm test:e2e / pnpm playwright) so I can re-check do-pr and AGENTS.md recommendations. @Pertempto

Summary of Changes

  • Added .opencode commands: do-pr, start-pr, avoid-mistake.
  • Reworked documentation: trimmed/rewrote AGENTS.md, added CONTRIBUTING.md, updated README.md.
  • Expanded specs/000-mvp.md and added UX/architecture notes.

Overall Feedback

  • Negative: Several agent-facing docs are missing exact, non-interactive commands and contain repo-specific assumptions (notably the do-pr test steps and a hardcoded CHANGELOG example to another repo). That will break automated flows; please make test commands configurable and concrete and fix the changelog link.

  • Positive: The documentation reorganization, added specs, and .opencode automation commands are a clear improvement — they make the project more approachable and enable future automation. Nice work on structuring the MVP tasks and agent guidance.

If you update the three files above and confirm the canonical test commands and package manager, I will re-review quickly. 🙂

# Changes Requested Please make the following changes before merging: - `.opencode/command/do-pr.md`: add explicit, configurable non-interactive test command variables (e.g. `TEST_CMD`, `TEST_UNIT_CMD`, `TEST_E2E_CMD`, `SINGLE_TEST_CMD`) with repository-default values and update any hardcoded examples (CHANGELOG link) to point to `https://github.com/kwila-cloud/market/pull/NN` or use a repo variable. - `AGENTS.md`: restore a minimal "Agent quick commands" section with exact non-interactive commands (install, unit test, e2e test, single test, docker dev start, build) or clearly point to `CONTRIBUTING.md` while still providing those concrete commands. - `README.md`: replace the non-standard admonition `> [!NOTE]` with a standard GitHub blockquote (single `>`), or confirm you intentionally want the current syntax and why it should be preserved. Please confirm the canonical package manager and exact test script names for this repo (e.g. `pnpm install`, `pnpm test`, `pnpm test:unit`, `pnpm test:e2e` / `pnpm playwright`) so I can re-check `do-pr` and `AGENTS.md` recommendations. @Pertempto ## Summary of Changes - Added `.opencode` commands: `do-pr`, `start-pr`, `avoid-mistake`. - Reworked documentation: trimmed/rewrote `AGENTS.md`, added `CONTRIBUTING.md`, updated `README.md`. - Expanded `specs/000-mvp.md` and added UX/architecture notes. ## Overall Feedback - Negative: Several agent-facing docs are missing exact, non-interactive commands and contain repo-specific assumptions (notably the `do-pr` test steps and a hardcoded CHANGELOG example to another repo). That will break automated flows; please make test commands configurable and concrete and fix the changelog link. - Positive: The documentation reorganization, added specs, and `.opencode` automation commands are a clear improvement — they make the project more approachable and enable future automation. Nice work on structuring the MVP tasks and agent guidance. If you update the three files above and confirm the canonical test commands and package manager, I will re-review quickly. 🙂
Pertempto commented 2025-11-08 20:15:52 -05:00 (Migrated from github.com)
Copy link

README.md includes a non-standard admonition block that won't render on GitHub.

This is the correct syntax in GitHub markdown.

> README.md includes a non-standard admonition block that won't render on GitHub. This is the correct syntax in GitHub markdown.
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!14
No description provided.