Skip to content

Update README to match current dev/build workflow#172

Open
bernalde wants to merge 4 commits intomainfrom
fix/157-refresh-readme-setup
Open

Update README to match current dev/build workflow#172
bernalde wants to merge 4 commits intomainfrom
fix/157-refresh-readme-setup

Conversation

@bernalde
Copy link
Member

@bernalde bernalde commented Mar 3, 2026

Summary

  • remove outdated steps to manually create Dockerfile and Gemfile
  • align Docker run/build commands with tracked repo files and image name
  • add optional native Ruby workflow
  • add a clear validate.sh pre-PR step
  • remove contradictory note about Dockerfile/Gemfile being gitignored

Why

Keeps README consistent with the actual repository setup and reduces onboarding friction.

Closes #157

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the repository’s README so local development and build instructions match the current, tracked Docker/Ruby setup and reduce onboarding friction (per #157).

Changes:

  • Removes outdated instructions to manually create Dockerfile/Gemfile and the contradictory note about them being gitignored.
  • Aligns Docker image name/commands to secquoia-website, including improved run flags.
  • Adds optional native Ruby workflow and a pre-PR validate.sh step.

You can also share your feedback on Copilot code review. Take the survey.

@bernalde
Copy link
Member Author

bernalde commented Mar 4, 2026

@ahribljan I assigned you as a reviewer of this PR. Verify that the new instructions in README are valid and document any comments you have in a review here

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.

Update README to match actual tracked build/dev setup

2 participants