docs: drop # <plugin-name> H1 from SUMMARY.md required structure#426
Open
docs: drop # <plugin-name> H1 from SUMMARY.md required structure#426
# <plugin-name> H1 from SUMMARY.md required structure#426Conversation
SUMMARY.md no longer needs to start with the plugin name as an H1. First line is now `## Overview` directly. Updated both required-structure template and Polymarket example block in EN + ZH developer guides.
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
1 participant
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.
Summary
Drop the
# <plugin-name>H1 line from the SUMMARY.md required-structure description in the developer guides. SUMMARY.md now starts directly with## Overview.Changes
### Required Structure): removed# <plugin-name>H1 line + the blank line that followed### Example: Polymarket Plugin): removed# polymarket-pluginH1 linedocs/FOR-DEVELOPERS.mdanddocs/FOR-DEVELOPERS-ZH.mdDiff size
2 files, -38 bytes per file (4 lines total removed across both files).
Note
The
E150/E151lint codes referenced in the doc are enforced inside the plugin-store Rust CLI. If that CLI still requires an H1 plugin-name as the first line of SUMMARY.md, a follow-up CLI change may be needed to keep doc and CLI aligned.