docs(dev): collapse per-language extension guides into <details> switches - #2247
Open
noron12234 wants to merge 1 commit into
Open
docs(dev): collapse per-language extension guides into <details> switches#2247noron12234 wants to merge 1 commit into
noron12234 wants to merge 1 commit into
Conversation
…ches Closes TEN-framework#1994. The extension development guide tiled all four language sections (C++, Go, Python, Node.js) on one page. A reader looking only for Python still had to scroll past ~200 lines of C++ and ~170 lines of Go before reaching the guide they wanted. Wrap each language section in a collapsible <details><summary> block so readers open the guide they need. Matches the existing collapsible pattern already used in docs/getting-started/websocket-voice-assistant-quick-start.md. Both English and Chinese versions updated symmetrically. Content untouched inside each section — only the outer boundaries changed.
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.
Closes #1994.
Problem
The extension development guide (
docs/development/how_to_develop_with_ext.mdand its.cn.mdcounterpart) tiled all four language sections (C++, Go, Python, Node.js) on one page. A reader looking only for Python still had to scroll past ~200 lines of C++ and ~170 lines of Go before reaching the guide they wanted. The Chinese version is the same shape and had the same problem.The issue asks for switch-like behavior instead of tiling.
Fix
Wrap each language section in a collapsible
<details><summary>block. Readers now see a compact list of four language guides and expand the one they need.Same shape in both
how_to_develop_with_ext.mdandhow_to_develop_with_ext.cn.md.Why this shape
docs/getting-started/websocket-voice-assistant-quick-start.mdalready uses<details><summary><strong>for its Troubleshooting section (five blocks). Reusing that pattern rather than inventing something.<details>renders on GitHub and on any Fumadocs / MDX / static-site renderer without additional imports. Noimport { Tabs }shim required.###subheadings that generate TOC anchors) is untouched. Diff is boundaries only.Verification
Both files preserve their inner
###subheading structure (Create Project,Run Tests, etc.) so any TOC generator or deep-link that pointed at those anchors still resolves.Files changed
docs/development/how_to_develop_with_ext.md(+24 −7)docs/development/how_to_develop_with_ext.cn.md(+24 −7)Alternatives considered
<Tabs>component — would need to convert the file to.mdxand add an import; larger blast radius and framework-specific. Happy to switch if the maintainers prefer tabs and can point me at the right component import path.#c-extension-developmentetc.