Move Getting Started into the Sidebar and also add to index #187
Conversation
WalkthroughA new "Getting Started" guide was added to the documentation, offering a step-by-step onboarding process for Agentuity users. The introduction page was simplified by removing detailed setup instructions and instead linking to the new guide. The section's metadata JSON was updated to include the new page. Changes
Poem
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
docs | b8a721a | Commit Preview URL | Jun 10 2025, 02:44 PM |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (6)
content/Introduction/index.mdx (2)
14-16: Inconsistent callout link text
The callout uses “Getting Started” while the closing link uses “Get Started.” Choose one phrasing and apply it to both to maintain consistency.
44-44: Unify call-to-action
The final line reads:If you're ready to have your own Agent, Get Started in just a few minutes.
Consider matching it exactly to the callout phrase (e.g., “Getting Started”) for uniformity.
content/Introduction/getting-started.mdx (4)
17-21: Correct casing of “macOS”
Change “MacOS” to “macOS” in the CLI installation step for Apple’s OS:- The [Agentuity CLI](/CLI/installation) is a cross-platform command-line tool for working with Agentuity Cloud. It supports Windows (using WSL), MacOS, and Linux. + The [Agentuity CLI](/CLI/installation) is a cross-platform command-line tool for working with Agentuity Cloud. It supports Windows (using WSL), macOS, and Linux.🧰 Tools
🪛 LanguageTool
[grammar] ~19-~19: The operating system from Apple is written “macOS”.
Context: ...Cloud. It supports Windows (using WSL), MacOS, and Linux. <CLICommand command="curl ...(MAC_OS)
27-29: Insert missing comma for clarity
Add a comma before “or” in the sign-up instruction:- You can sign up for a free account using the CLI or skip this step if you already have an account. + You can sign up for a free account using the CLI, or skip this step if you already have an account.🧰 Tools
🪛 LanguageTool
[uncategorized] ~27-~27: Possible missing comma found.
Context: ...an sign up for a free account using the CLI or skip this step if you already have a...(AI_HYDRA_LEO_MISSING_COMMA)
35-37: Use “log in” instead of “login” and rephrase
“Login” is a noun; use the verb “log in,” and consider separating “otherwise” for readability:- You can skip this step if you used the CLI to sign up for an account, otherwise you must login to your account using the CLI. + You can skip this step if you used the CLI to sign up. Otherwise, you must log in to your account using the CLI.🧰 Tools
🪛 LanguageTool
[typographical] ~35-~35: The word “otherwise” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...p if you used the CLI to sign up for an account, otherwise you must login to your account using th...(THUS_SENTENCE)
[misspelling] ~35-~35: Did you mean the verb “log in” instead of the noun ‘login’?
Context: ...n up for an account, otherwise you must login to your account using the CLI. <CLICom...(LOG_IN)
43-53: Vary sentence structure in step descriptions
Multiple steps begin with “You can…”. For stylistic variety and improved engagement, consider rephrasing some lines (e.g., “Select a template to…” or “Run your agent locally to…”).🧰 Tools
🪛 LanguageTool
[style] ~50-~50: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ep> ### Run Your Agent Locally You can run your agent locally to test it o...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
content/Introduction/getting-started.mdx(1 hunks)content/Introduction/index.mdx(2 hunks)content/Introduction/meta.json(1 hunks)
🧰 Additional context used
🪛 LanguageTool
content/Introduction/getting-started.mdx
[grammar] ~19-~19: The operating system from Apple is written “macOS”.
Context: ...Cloud. It supports Windows (using WSL), MacOS, and Linux. <CLICommand command="curl ...
(MAC_OS)
[uncategorized] ~27-~27: Possible missing comma found.
Context: ...an sign up for a free account using the CLI or skip this step if you already have a...
(AI_HYDRA_LEO_MISSING_COMMA)
[typographical] ~35-~35: The word “otherwise” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...p if you used the CLI to sign up for an account, otherwise you must login to your account using th...
(THUS_SENTENCE)
[misspelling] ~35-~35: Did you mean the verb “log in” instead of the noun ‘login’?
Context: ...n up for an account, otherwise you must login to your account using the CLI. <CLICom...
(LOG_IN)
[style] ~42-~42: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... ### Create Your First Project You can select a template to get started qu...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~50-~50: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ep> ### Run Your Agent Locally You can run your agent locally to test it o...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Workers Builds: docs
🔇 Additional comments (1)
content/Introduction/meta.json (1)
3-8: Pages array updated correctly
The new"getting-started"entry is added in the intended position, and the multi-line formatting improves readability.
jhaynie
deleted the
jhaynie/agent-331-move-getting-started-to-the-top-on-the-doc-site
branch
Summary by CodeRabbit