Skip to content

Tool manifest and microservice getting started#100

Merged
Leinnan merged 2 commits into
core/v7.1from
createToolManifest
May 22, 2026
Merged

Tool manifest and microservice getting started#100
Leinnan merged 2 commits into
core/v7.1from
createToolManifest

Conversation

@Leinnan
Copy link
Copy Markdown
Contributor

@Leinnan Leinnan commented May 19, 2026

I am not sure about yet if I want to merge this.

On one hand it describes how user can create a tool manifest just like we do during engine integration setup, but on the other it could be a bit of duplicated info which would maybe be better to live in microservices.md.

What do yall think?

Copy link
Copy Markdown
Contributor

@allister-beamable allister-beamable left a comment

Choose a reason for hiding this comment

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

Fine to commit as-is, or apply prose wording changes if you like my suggestion.

Comment thread docs/cli/guides/getting-started.md Outdated
dotnet tool install Beamable.Tools
```

The first three commands create the folder and register a `.config/dotnet-tools.json` manifest. The fourth installs the Beam CLI into that manifest. From this folder, `dotnet beam` runs the locally installed CLI.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Something about this prose description feels overly specific; is there a way to phrase it that feels more like warm human segue between code blocks that speak for themselves?

Maybe like, "These commands establish a tool manifest in a new folder of your choice. You can confirm by looking at .config/dotnet-tools.json; when in this folder, dotnet beam will use this specific Beam CLI."

Or something? 😸

Honestly, it reads fine as it is; just spitballing to see if there is room for improvement!

@allister-beamable
Copy link
Copy Markdown
Contributor

We should back-propagate this to core/v7.0 after merging; I can do that after you merge this PR, @Leinnan

@allister-beamable
Copy link
Copy Markdown
Contributor

Regarding the question about duplicating microservices.md, what you have written here definitely feels appropriate as "CLI Getting Started" subject matter. A link from microservices.md to here could be good if there is a juncture in the Microservices docs that feels appropriate. Up to you, @Leinnan! I think it works fine either way.

@Leinnan Leinnan merged commit bb0ad13 into core/v7.1 May 22, 2026
1 check passed
@allister-beamable allister-beamable deleted the createToolManifest branch May 22, 2026 14:48
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