Trim README prose duplicated by the website documentation#49
Merged
Conversation
The README and https://professional.wiki/en/extension/native-markdown carried the same explanatory prose (configuration semantics, conversion-script selector details, template placement rules), which drifts as releases land. The website page is now the canonical home of the explanatory documentation and is being extended to a superset of what the README drops, while the README keeps everything needed to install, configure, and operate the extension from a checkout: installation, the configuration table, script invocations, the agent-facing API examples, development setup, and release notes. Each trimmed section ends in a link to the corresponding website documentation, and the comparison section is condensed the same way, with the full version on the website. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #49 +/- ##
=========================================
Coverage 83.41% 83.41%
Complexity 416 416
=========================================
Files 40 40
Lines 1067 1067
=========================================
Hits 890 890
Misses 177 177 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
The live page's templates subsection has its own anchor (#templates), verified against the deployed page, so link it directly rather than the parent #Usage section. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
JeroenDeDauw
marked this pull request as ready for review
July 17, 2026 19:13
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.
The README and https://professional.wiki/en/extension/native-markdown carried the same explanatory prose
(configuration semantics, conversion-script selector details, template placement rules), which drifts as
releases land. The website page is now the canonical home of the explanatory documentation and is being
extended to a superset of what the README drops, while the README keeps everything needed to install,
configure, and operate the extension from a checkout: installation, the configuration table, script
invocations, the agent-facing API examples, development setup, and release notes. Each trimmed section ends
in a link to the corresponding website documentation, and the comparison section is condensed the same way,
with the full version on the website.