Repository navigation
docs: align getting-started, guides, understand, and reference docs - #4
Merged
Merged
Conversation
Fill in the Documentation toc entries that pointed at pages which never existed (guides/, understand/, reference/ were empty). Adds: - getting-started/first-slice.md — a Planned-to-Done walkthrough - guides/connect-a-board.md — credentials, config resolution, /connect - understand/the-loop.md — the two independent triggers and slice-type routing, grounded in ralph.sh - reference/cli-commands.md — install/uninstall/status reference Also fixes the install.md 'Verify Installation' step, which pointed at a path the installer never creates (node .build-kit/cli.js), and points README.md's broken Documentation/ links at the pages that actually exist. The three sibling kits (C#, Kotlin, Java) now carry an identical toc.yml and section structure, so their docs read as one aligned set.
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.
Fills in the
Documentation/toc entries that pointed at pages which never existed (guides/,understand/,reference/were empty directories, or — for Kotlin/Java — didn't exist in the toc at all).Adds:
getting-started/first-slice.md— a Planned-to-Done walkthroughguides/connect-a-board.md— credentials, config resolution,/connectunderstand/the-loop.md— the two independent triggers and slice-type routing, grounded inralph.shreference/cli-commands.md—install/uninstall/statusreferenceAlso fixes
install.md's Verify Installation step, which pointed at a path the installer never creates (node .build-kit/cli.js status— the CLI is invoked vianpx github:..., not a local copy), and repoints README.md's brokenDocumentation/links at pages that actually exist (the old links pointed atreference/skills.md,reference/cratis-conventions.md, andguides/recover-stuck-slice.md, none of which existed).The three sibling kits (C#, Kotlin, Java) now carry an identical
toc.ymland section structure, so their docs read as one aligned set — this is what the Documentation site's new EventModelers.ai nav topic (Cratis/Documentation#TBD) surfaces per language.🤖 Generated with a coding agent.