fix: add CLI to Developer Tools overview, dedupe MCP Setup title#276
Merged
Conversation
The Developer Tools overview page listed SDK Guide, SDK API, Platform API and MCP Server but omitted the CLI, even though it has its own sidebar category. Added a CLI section and table row. The MCP Server Setup page rendered its H1 twice: `export const` MDX declarations before the in-content `# Setup` heading stopped Docusaurus's title parser from detecting it (it only strips leading `import` statements), so it fell back to rendering the frontmatter title as a synthetic H1 on top of the literal one. Added `hide_title: true`, the same pattern already used elsewhere in this repo for pages with pre-heading MDX exports.
joalves
requested review from
bmsilva,
calthejuggler,
marcio-absmartly and
mario-silva
as code owners
WalkthroughThis change adds a CLI subsection and comparison-table entry to the APIs-and-SDKs overview. It updates CLI authentication and configuration examples to use a readonly profile, removes a credential-permissions note, removes the CLI stability table, revises the non-interactive setup example, and removes the standalone heading from the MCP Server setup page. Estimated code review effort: 2 (Simple) | ~12 minutes Possibly related PRs
Suggested reviewers: Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
✅ Deploy Preview for absmartly-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
calthejuggler
approved these changes
Jul 9, 2026
| --- | ||
| title: Setup | ||
| sidebar_position: 3 | ||
| hide_title: true |
Collaborator
There was a problem hiding this comment.
Why not just remove the title from the markdown? 😅
Collaborator
Author
There was a problem hiding this comment.
Good call, done — removed the redundant # Setup heading from the content instead.
Remove the status table from the CLI overview page — it read as an internal engineering tracker rather than customer-facing docs. Reword profile examples: customers only ever have one instance, so a "staging" profile with a different endpoint was a misleading example. Profiles are more realistically used to switch between credentials with different permissions (e.g. a read-only key), so all examples now use a "readonly" profile against the same endpoint. Also drop the parenthetical "(chmod 600)" from the Authentication page intro — an implementation detail that reads oddly out of context.
calthejuggler
approved these changes
Jul 9, 2026
Per review feedback, dropping the duplicate `# Setup` heading from the content is simpler than hiding the frontmatter title with hide_title: true — same rendered result, one less frontmatter flag.
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
2 participants
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.
Summary
docs/APIs-and-SDKs/overview.mdx) listed SDK Guide, SDK API, Platform API and MCP Server but never mentioned the CLI, even though it has its own sidebar category (CLI-Documentation). Added a "CLI" section and a row in the "Which one should I use?" table.docs/APIs-and-SDKs/MCP-Server/setup.mdx) rendered the "Setup" title twice. Root cause: the page hasexport const ...MDX declarations before its in-content# SetupH1. Docusaurus'sparseMarkdownContentTitleonly strips leadingimportstatements, notexport, so it never finds the H1 and falls back to rendering the frontmattertitle: Setupas a synthetic heading — on top of the literal# Setupalready in the content. Fixed by removing the redundant# Setupheading from the content itself (simpler thanhide_title: true, per review feedback), so the frontmattertitlerenders as the only H1.CLI-Documentation/index.mdx) — it read like an internal engineering tracker rather than customer-facing docs.--profile stagingexamples acrossCLI-Documentation/index.mdx,authentication.mdxandconfiguration.mdx. Customers only ever have one ABsmartly instance, so an example profile pointed at a different endpoint (staging.absmartly.com) was misleading. Profiles are more realistically used to switch between credentials with different permissions (e.g. a read-only key), so all examples now use areadonlyprofile against the same instance.(chmod 600)from the CLI Authentication page's intro paragraph — an implementation detail that read oddly out of context for docs.Test plan
yarn install+npx docusaurus startin an isolated worktree and confirmed the dev build compiles successfully/docs/APIs-and-SDKs/MCP-Server/setupnow renders exactly one<h1>Setup</h1>/docs/APIs-and-SDKs/overviewnow shows a CLI section with working links toCLI-Documentationpages, and a CLI row in the comparison table/docs/APIs-and-SDKs/CLI-Documentation/no longer shows the status table, and/docs/APIs-and-SDKs/CLI-Documentation/authenticationno longer shows(chmod 600)and usesreadonlyprofile examplesSummary by CodeRabbit
readonlyprofiles (instead ofstaging) for authentication and configuration.