Skip to content

Jg/review readmes#400

Merged
jjeangal merged 4 commits intocelo-integration-rebase-16.2from
jg/review-readmes
Apr 9, 2026
Merged

Jg/review readmes#400
jjeangal merged 4 commits intocelo-integration-rebase-16.2from
jg/review-readmes

Conversation

@jjeangal
Copy link
Copy Markdown
Member

@jjeangal jjeangal commented Apr 8, 2026

This PR:

  • Cleans up the espresso readme file.

@claude
Copy link
Copy Markdown

claude Bot commented Apr 8, 2026

Claude finished @jjeangal's task in 2m 40s —— View job


Review of PR #400

  • Gather context and read existing review comments
  • Review changes to README_ESPRESSO.md
  • Review changes to espresso/docs/README_ESPRESSO_CODE_SYNC_PROCEDURE.md
  • Review changes to espresso/docs/README_ESPRESSO_DEPLOY_CONFIG.md
  • Post review feedback

Summary

Nice cleanup overall. The reorganization is a clear improvement — moving detailed procedures into dedicated docs files, adding the "Quick start vs Manual setup" split for the devnet section, and fixing formatting throughout. Several real corrections too (sudo add group dockersudo groupadd docker, espresso/scrips/espresso/scripts/, verfierverifier).

Issues Found

Bugs (should fix before merge):

  • github.com was capitalized to GitHub.com in 3 clone/documentation URLs (lines 10, 28, 214). While DNS is case-insensitive, SSH config matching can be case-sensitive and this is unconventional. Suggestions provided.
  • .github/workflows/ was capitalized to .GitHub/workflows/ in 2 places (lines 475, 478). The actual filesystem path is lowercase .github. The filename update to espresso-enclave.yaml is correct.

Nit:

  • Heading hierarchy: ## Development environment was changed to # Development environment, creating multiple h1s and h1→h3 jumps without h2. Consider reverting to ##.
  • README_ESPRESSO_CODE_SYNC_PROCEDURE.md line 263: leftover sentence about "EOD next Monday" doesn't fit under the Docker image update step.

README_ESPRESSO_DEPLOY_CONFIG.md changes look good — the allocs.json generation steps are clear and well-formatted.

Comment thread README_ESPRESSO.md Outdated
Comment thread README_ESPRESSO.md Outdated
Comment thread README_ESPRESSO.md Outdated
Comment thread README_ESPRESSO.md Outdated
Comment thread README_ESPRESSO.md Outdated
Comment thread README_ESPRESSO.md Outdated
Comment thread espresso/docs/README_ESPRESSO_CODE_SYNC_PROCEDURE.md Outdated
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request significantly restructures and updates the project documentation, primarily in README_ESPRESSO.md. It introduces a new quick-start guide using convenience scripts, provides detailed manual setup instructions via Docker Compose, and adds new commands for container management. Additionally, it migrates detailed procedures for code synchronization and deployment configuration into dedicated documentation files. Review feedback suggests correcting the casing of the .github directory in workflow paths to ensure compatibility and removing transient process notes regarding internal deadlines from the permanent documentation.

Comment thread README_ESPRESSO.md Outdated
Comment thread espresso/docs/README_ESPRESSO_CODE_SYNC_PROCEDURE.md Outdated
Copy link
Copy Markdown
Member

@shenkeyao shenkeyao left a comment

Choose a reason for hiding this comment

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

Just a nit comment!

Comment thread README_ESPRESSO.md
@jjeangal jjeangal merged commit 6b139b3 into celo-integration-rebase-16.2 Apr 9, 2026
42 checks passed
@jjeangal jjeangal deleted the jg/review-readmes branch April 9, 2026 14:36
QuentinI pushed a commit that referenced this pull request Apr 9, 2026
* fix espresso file naming

* last clean up + reorganize sections

* fix ai comments

* address nit
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.

2 participants