Skip to content

Refresh docs site contributing guide#257

Merged
version-1 merged 1 commit into
mainfrom
docs/refresh-contributing
Jul 7, 2026
Merged

Refresh docs site contributing guide#257
version-1 merged 1 commit into
mainfrom
docs/refresh-contributing

Conversation

@version-1

Copy link
Copy Markdown
Owner

Refresh Docs Site Contributing Guide

Summary

Update the docs-site Contributing pages so contributors can choose the right local environment, run current Makefile workflows, and select appropriate verification.

主な変更点:

  • Expanded Compose vs host-only setup guidance.
  • Added Codex/GitHub CLI authentication notes and Linux/WSL2 sandbox guidance.
  • Added local smoke-flow and local-state reset guidance.
  • Added a verification matrix for Go, Web UI, docs, API contracts, and end-to-end service flows.

チケットへのリンク

ここはまだない

やったこと

  • Updated English Contributing pages: Development Setup, Running Locally, Testing.
  • Updated matching Japanese Contributing pages.
  • Verified the docs site build.

動作確認

  • npm run build from docs/site
  • Confirmed branch is based on latest origin/main
  • Confirmed working tree is clean before PR creation

レビュー & 動作確認 チェックリスト

  • Contributing setup flow - Compose and host-only guidance matches current Makefile behavior.
  • Testing guidance - Recommended checks match the changed area and do not over-prescribe.
  • Japanese docs parity - Japanese pages stay synchronized with the English source pages.

推奨テスト計画:

  1. Run npm run build from docs/site.
  2. Open Contributing pages in English and Japanese.
  3. Verify the command examples match make help.

その他気になることや相談ごと

なし

Notes
Requested by: user

Expand the docs-site Contributing pages with current Compose and host workflows, authentication notes, local smoke checks, and verification guidance.

Keep English and Japanese pages synchronized.

Verification: npm run build in docs/site.
@version-1 version-1 enabled auto-merge July 7, 2026 06:18
@version-1 version-1 merged commit 326470a into main Jul 7, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant