-
Notifications
You must be signed in to change notification settings - Fork 3
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or requestgood first issueGood for newcomersGood for newcomers
Description
Issue Description
The current documentation for the ETH ID MCP server under "Quick Setup" presents two options but the formatting makes it unclear that these are alternative approaches rather than sequential steps:
Current presentation suggests:
- Option One: Use the online server
- Option Two: Run locally
This can be interpreted as "do step 1, then step 2" when they are actually mutually exclusive options.
Suggested Fix
Restructure the Quick Setup section to clearly indicate these are alternative approaches:
Option A: Use Online Server (Recommended)
[Current Option One content]
Option B: Run Locally
[Current Option Two content]
Alternative Solutions
- Add introductory text like: "Choose one of the following setup methods:"
- Use radio button styling or clear visual separation
- Add a comparison table showing when to use each option
- Include "OR" dividers between the sections
Impact
This confusion could lead users to:
- Attempt both setups unnecessarily
- Follow incorrect installation procedures
- Experience setup failures from mixed approaches
Location
- Page: ETH ID MCP Server documentation
- Section: Quick Setup
- Subsection: Setup options
Priority
Low - Documentation clarity improvement
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or requestgood first issueGood for newcomersGood for newcomers