Skip to content

Restructure README into Quick Start and Advanced Guide#51

Merged
pardeike merged 2 commits intomainfrom
copilot/suggest-docs-improvement-dotnet-tool-support
Apr 18, 2026
Merged

Restructure README into Quick Start and Advanced Guide#51
pardeike merged 2 commits intomainfrom
copilot/suggest-docs-improvement-dotnet-tool-support

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 13, 2026

README was a flat technical doc that assumed .NET familiarity. Restructured into two sections so beginners can get running without wading through build-from-source details, while experts can skip straight to the advanced content.

Quick Start

  • Step-by-step install from release binaries with platform table
  • Collapsible MCP client config for Claude Desktop, Cursor, and VS Code
  • Natural-language first-use example
  • Troubleshooting table (missing runtime, macOS quarantine, path issues, etc.)

Advanced Guide

  • All existing content preserved: build from source, detailed launch options, full workflow reference, dev/release instructions

Top-of-page callout links experts directly to the Advanced Guide. Language targets non-native English speakers without being patronizing.

Split the README into two clearly separated parts:

- Quick Start: step-by-step install from release binaries, MCP client
  configuration examples (Claude Desktop, Cursor, VS Code), first-use
  guidance, and a troubleshooting table.

- Advanced Guide: build from source, detailed MCP launch options, full
  workflow reference, development, releasing, and documentation links.

The Quick Start section uses simple language and collapsible details to
keep the beginner flow focused. Expert users can skip directly to the
Advanced Guide via a callout at the top.

Agent-Logs-Url: https://github.com/pardeike/DecompilerServer/sessions/c33d3aaf-5770-4ac5-8eb0-34826f8f45a9

Co-authored-by: pardeike <853584+pardeike@users.noreply.github.com>
Copilot AI changed the title [WIP] Improve installation documentation and add dotnet tool support Restructure README into Quick Start and Advanced Guide Apr 13, 2026
Copilot AI requested a review from pardeike April 13, 2026 09:51
@pardeike pardeike marked this pull request as ready for review April 18, 2026 07:21
@pardeike pardeike merged commit 03790cb into main Apr 18, 2026
1 check passed
@pardeike pardeike deleted the copilot/suggest-docs-improvement-dotnet-tool-support branch April 18, 2026 07:22
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.

Suggest documentation improvement & dotnet tool install support for easier onboarding

2 participants