docs: condense README - #37
Merged
Merged
Conversation
Cut the README from 380 to 137 lines. Fold Workflow Guide, Recent Changes, Development and API Surface into their neighbouring sections, keep a single screenshot, and turn Troubleshooting into a table. Drop the Project Structure tree and the Known limits section.
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
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.
Description
Cuts the README from 380 to 137 lines. Documentation only, no behaviour changes.
Structural edits:
<p align="center">and<br>padding around it.Content removed:
detectionsplugin, coarse platform matching, unchecked fusion identity, and the un-scopedrun_operation. Happy to restore it if you would rather keep those caveats published.Everything else survives intact: the what-to-run vs where-to-run framing, the pipeline diagram, both env vars, the Caldera connection exceptions, and the three
conf/local.ymloverlay gotchas.The three now-unreferenced screenshots are still in
docs/images/rather than deleted, in case you want one swapped back in.Type of change
Documentation only. None of the template categories apply, so all four are deleted per the template instructions.
How Has This Been Tested?
No code changed, so no test run applies. Verification was limited to the document itself:
docs/images/mcp-main-screen.png,PLUGIN_MCP.md, and the#caldera-connectionanchor used by the troubleshooting table.Checklist: