Repository navigation
Add a getting-started page, and fix the shebang that broke ./build.cs - #6
Merged
Merged
Conversation
…fail The docs had no install step and no first build: the target DSLs lived only in the package READMEs, which suited a section of argh's site but not runna's own. Getting started installs Runna or Runna.Fs and builds the same three targets in C# and in F#, with the help and plan they print. The landing page's get-started links go there. Every C# example started with `#!/usr/bin/env -S dotnet run --`, which turns `./build.cs` into `dotnet run -- ./build.cs` and fails looking for a project. The shebang is now `#!/usr/bin/env -S dotnet --`, which passes every argument, --help included, to the script. Also: "per Make target" in the make page names the tool runna. Co-Authored-By: Claude Opus 5.5 <[email protected]>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The docs get a getting-started page with a first build in C# and in F#, and every C# example's shebang now works when the file is run as
./build.cs.Prompt summary: Check runna's docs now that it is its own product with its own site and packages.
Why
Nothing in the docs said how to install runna or write a first build: the DSLs were only in the package READMEs, which suited a section of argh's site but not runna's own. The landing page's "get started" buttons led to "Choosing what runs", which assumes a build already exists. Running the examples as written also showed that
./build.csfailed:#!/usr/bin/env -S dotnet run --becomesdotnet run -- ./build.cs, and dotnet looks for a project instead.What
Getting started
A new page after the index installs
RunnaorRunna.Fs, builds the same three targets in C# (a file-based app) and in F# (a small project), shows the help and plan they print, and links on. The landing page's get-started and docs links point to it.The shebang
#!/usr/bin/env -S dotnet --, as the .NET file-based apps docs show, in the READMEs, the landing page, the skill and the design notes../build.cs --helpreaches the script; without the--, dotnet takes--helpitself.A missed rename
The make page said "one phony target per Make target"; it names runna now.
Verify
I ran the page as written against the published
RunnaandRunna.Fs0.2.0:chmod +x build.cs && ./build.cs --help,dotnet run build.cs -- test --graph, and the F# project's--helpandtest --graph. The help and plan on the page are their real output.scripts/docs.sh # then open http://localhost:4000/getting-started/🤖 Generated with Claude Code