这是indexloc提供的服务,不要输入任何密码
Skip to content

Conversation

@dexhorthy
Copy link
Contributor

@dexhorthy dexhorthy commented Oct 16, 2025

What problem(s) was I solving?

The documentation had inconsistent code formatting and outdated command examples that could confuse users. Specifically:

  • The JSON comment syntax was using block comment style (/* */) instead of line comment style (//) which is more appropriate for JSONc files
  • The command example was using npx humanlayer when the tool is now installed directly via brew
  • The code block wasn't properly syntax-highlighted

What user-facing changes did I ship?

  • Updated the settings.json example to use proper JSONc comment syntax (// instead of /* */)
  • Simplified the humanlayer launch command from npx humanlayer to humanlayer to reflect current installation method
  • Added proper syntax highlighting to the bash command block for better readability

How I implemented it

Made three targeted changes to docs/introduction.mdx:

  1. Changed the comment style in the settings.json example from block comments to line comments for JSONc consistency
  2. Updated the humanlayer launch command to remove the npx prefix since users install via brew now
  3. Added bash language identifier to the code block for proper syntax highlighting

How to verify it

Manual Testing

  • View the rendered documentation to ensure formatting appears correct
  • Verify the JSONc comment syntax is highlighted properly
  • Confirm the bash command block has proper syntax highlighting
  • make check passes (note: unrelated type errors in humanlayer-wui exist)
  • make test passes (note: unrelated integration test failures in hld exist)

Description for the changelog

docs: improve code formatting and update command examples in introduction

Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

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

Important

Looks good to me! 👍

Reviewed everything up to b48584b in 1 minute and 17 seconds. Click for details.
  • Reviewed 24 lines of code in 1 files
  • Skipped 0 files when reviewing.
  • Skipped posting 2 draft comments. View those below.
  • Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.
1. docs/introduction.mdx:72
  • Draft comment:
    Changed comment style in the JSONC snippet from block (/* */) to a single-line (//) comment. Ensure this style is consistent throughout the docs.
  • Reason this comment was not posted:
    Confidence changes required: 33% <= threshold 50% None
2. docs/introduction.mdx:91
  • Draft comment:
    Removed the 'npx' prefix from the CLI command. Confirm that the CLI is expected to be globally available or update the instructions accordingly.
  • Reason this comment was not posted:
    Confidence changes required: 33% <= threshold 50% None

Workflow ID: wflow_v7sReShn2Ss3najw

You can customize Ellipsis by changing your verbosity settings, reacting with 👍 or 👎, replying to comments, or adding code review rules.

@dexhorthy dexhorthy merged commit acea337 into main Oct 18, 2025
6 of 8 checks passed
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