Skip to content

docs: add instructions for running the documentation site locally#4818

Merged
cuixq merged 7 commits intogoogle:masterfrom
cuixq:docs
Feb 23, 2026
Merged

docs: add instructions for running the documentation site locally#4818
cuixq merged 7 commits intogoogle:masterfrom
cuixq:docs

Conversation

@cuixq
Copy link
Contributor

@cuixq cuixq commented Feb 16, 2026

This PR updates docs/README.md to provide clearer instructions for contributors to run and test the documentation site locally in docker or natively.

To run documentation site in docker, this PR introduces docs/docs.Dockerfile to allow consistent local documentation serving without requiring a local Ruby environment.

Copy link
Contributor

@another-rex another-rex left a comment

Choose a reason for hiding this comment

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

Can you add the dockerfile in osv-scanner, and add that to the instructions? I've always had trouble building directly with bundler.

@cuixq
Copy link
Contributor Author

cuixq commented Feb 16, 2026

/gemini review

Copy link
Contributor

@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 introduces instructions and a Dockerfile for running the documentation site locally. The changes to docs/README.md add sections for both Docker-based and native local development, and the new docs/docs.Dockerfile is intended to provide a consistent environment.

My review focuses on improving the new Docker setup. I've identified a critical issue in the Dockerfile where an invalid base image is used, which will prevent it from building. I have also suggested improvements to the README.md instructions to clarify the required working directory and to enhance the docker run command for a better developer experience with live-reloading.

@cuixq cuixq marked this pull request as ready for review February 16, 2026 05:58
@another-rex
Copy link
Contributor

We probably can just remove the .bundle copy part.

Though @cuixq can you test if you can actually run the docs locally? I seem to be getting conflicts on unable to resolve the dependencies

@cuixq
Copy link
Contributor Author

cuixq commented Feb 20, 2026

@another-rex it seems due to the ruby version e.g. commonmarker 0.23.12 has requirement >= 2.6, < 4.0.

I have modified the docker image to be using ruby:3 for now. We probably need to do this for osv-scanner too.

@cuixq cuixq merged commit 7067244 into google:master Feb 23, 2026
20 checks passed
@cuixq cuixq deleted the docs branch February 23, 2026 00:35
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.

3 participants