Skip to content

docs: add cli generator#51

Merged
dgageot merged 14 commits intodocker:mainfrom
ArthurFlag:ENGDOCS-2813-cli-docs
Jul 25, 2025
Merged

docs: add cli generator#51
dgageot merged 14 commits intodocker:mainfrom
ArthurFlag:ENGDOCS-2813-cli-docs

Conversation

@ArthurFlag
Copy link
Contributor

No description provided.

Copy link
Member

@crazy-max crazy-max left a comment

Choose a reason for hiding this comment

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

@ArthurFlag ArthurFlag marked this pull request as ready for review July 22, 2025 09:37
@ArthurFlag ArthurFlag requested a review from a team as a code owner July 22, 2025 09:37
@ArthurFlag
Copy link
Contributor Author

@crazy-max, David kindly fixed the problem, things are working now, would you mind taking a final look when you can?

Copy link
Member

@crazy-max crazy-max left a comment

Choose a reason for hiding this comment

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

You also need to add a job to validate docs similar to https://github.com/docker/model-cli/blob/main/.github/workflows/validate.yml

@ArthurFlag ^

See also my previous review for the Dockerfile

@ArthurFlag ArthurFlag requested review from crazy-max July 23, 2025 14:25
Copy link
Member

@crazy-max crazy-max left a comment

Choose a reason for hiding this comment

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

Small nit otherwise nicely done!

Also I guess as follow-up there will be some examples and a better description for commands. Atm it's hard to understand what they mean and what they do if we publish as-is on docs website.

Copy link
Member

@crazy-max crazy-max left a comment

Choose a reason for hiding this comment

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

👀 https://github.com/docker/mcp-gateway/actions/runs/16490847205/job/46624943785?pr=51#step:3:479

#15 0.694 ERROR: Docs result differs. Please update with "make docs"
#15 0.708  M docs/generator/reference/docker_mcp_gateway_run.yaml

@ArthurFlag
Copy link
Contributor Author

mmmh, I can't reproduce locally, I'm not sure how to diagnose further, any idea?

@crazy-max
Copy link
Member

That's the because validation is based on merged pull request with base branch so you need to rebase and run make docs again. This is to avoid merging faulty changes.

I just tried on my side and it works. You can cherry-pick this commit if you want: crazy-max@1d676e1

@ArthurFlag ArthurFlag requested a review from crazy-max July 25, 2025 09:50
@dgageot dgageot merged commit 8e89765 into docker:main Jul 25, 2025
5 checks passed
@ArthurFlag ArthurFlag deleted the ENGDOCS-2813-cli-docs branch July 25, 2025 12:58
null-runner pushed a commit to null-runner/mcp-gateway that referenced this pull request Dec 6, 2025
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