cli: add generated MCP cli refs #23169
Conversation
ArthurFlag
requested review from
sarahsanders-docker and
thaJeztah
as code owners
✅ Deploy Preview for docsdocker ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
github-actions
bot
added
area/cli
ArthurFlag
force-pushed
the
ENGDOCS-2813-cli-docs
branch
from
ba5fa9e to
0ea85db
Compare
ArthurFlag
force-pushed
the
ENGDOCS-2813-cli-docs
branch
from
0ea85db to
3d5c937
Compare
There was a problem hiding this comment.
For the docs repository, we probably only need the YAML files (as the docs uses its own templates to convert those to markdown). Not sure how we did that for other repositories that committed the generated files in source control though (do we put the markdown and yaml in separate directories for those?). @crazy-max do you know?
There was a problem hiding this comment.
Only yaml files are consumed https://github.com/docker/docs/pull/23169/files#diff-5928f4025679c9eee397ca3795367f71f667ce1f25018b7f7ae7c574da1f2f08R359 but markdown files seem to also be vendored like compose for example: https://github.com/docker/docs/tree/main/_vendor/github.com/docker/compose/v2/docs/reference
That might be how hugo works 🤔
There was a problem hiding this comment.
Starting to wonder if we need to start considering adding another level in our hierarchy (reference/cli/docker/mcp/catalog_reset/ -> reference/cli/docker/mcp/catalog/reset/). I know we had some of that with docker buildx imagetools inspect, but I think we kept the deeply nested at the same level at the time.
There was a problem hiding this comment.
Oh! Actually, we didn't that's also using an extra hierarchy; https://docs.docker.com/reference/cli/docker/buildx/imagetools/inspect/#format
There was a problem hiding this comment.
Right, yeah, looks like we have some changes to make for the navigation; looking at the preview;
|
@crazy-max Would you able to take another look at your convenience? |
Add generated MCP docs.