Skip to content

Add Web Frontend documentation to README#3

Merged
pemulis merged 1 commit intomainfrom
codex/add-web-frontend-section-to-readme.md
Jan 14, 2026
Merged

Add Web Frontend documentation to README#3
pemulis merged 1 commit intomainfrom
codex/add-web-frontend-section-to-readme.md

Conversation

@pemulis
Copy link
Copy Markdown
Contributor

@pemulis pemulis commented Jan 14, 2026

Motivation

  • Add a Web Frontend section to README.md to document a lightweight UI that mirrors the deploy script by describing dependencies, local dev commands, required RPC/default address env vars, form-to-onchain-parameter mappings, and a static-hosting deployment note.

Description

  • Updated README.md to add a Web Frontend section that lists frontend dependencies, local development steps (npm install, npm run dev), required environment variables (e.g., MAINNET_RPC_URL, SEPOLIA_RPC_URL, SAFE_SINGLETON, OG_MASTER_COPY, MODULE_PROXY_FACTORY), the mapping from UI form fields to deployment parameters (e.g., Safe OwnersSAFE_OWNERS, OG RulesOG_RULES), and guidance on static build output (e.g., dist/ or build/) and hosting.

Testing

  • No automated tests were run because this is a documentation-only change.

Codex Task

@pemulis pemulis merged commit 1e777c7 into main Jan 14, 2026
2 checks passed
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: c10af1f580

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

- **OG Collateral Token** → `OG_COLLATERAL`
- **OG Bond Amount** → `OG_BOND_AMOUNT`
- **OG Rules (Natural Language)** → `OG_RULES`
- **OG Challenge Period** → `OG_CHALLENGE_PERIOD`
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Map challenge period to OG_LIVENESS to avoid silent ignore

The new frontend mapping tells users to wire OG Challenge Period to OG_CHALLENGE_PERIOD, but the deployment script reads OG_LIVENESS (see DeploySafeWithOptimisticGovernor.loadConfig), so any UI that follows this doc will silently ignore the value and deploy with the default 2‑day liveness. This misconfiguration is easy to miss and results in incorrect governance timing for deployments driven by the frontend.

Useful? React with 👍 / 👎.

@pemulis pemulis deleted the codex/add-web-frontend-section-to-readme.md branch February 3, 2026 16:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant