Rewrite/clarify doc using skills#51
Merged
Merged
Conversation
- new guide covering backend round-trip: loading raw data, saving update-config payload, and persisting render-table snapshots - sidebar entry and cross-link from loading-data guide
- imperative headings (gerund → infinitive) - active voice, present simple - backticks for API identifiers (replaced bold) - added intro sentences for code blocks - added section on Pivot instance methods (getTable, setConfig, setLocale, showConfigPanel)
- corrected method chain: widget.api.getTable().exec → widget.getTable().api.exec, per API docs - active voice, approved code-block intro template - added tip about getTable wait parameter - formatting fixes (spaces in inline code, comma cleanups)
- added missing H1 (consistent with sibling guides) - split "Loading data" into "Load data from a file" and "Load data from a server" - imperative headings, active voice - introduced setConfig method (used in code without explanation before) - removed awkward single-item API list, replaced with prose - approved code-block intro templates, normalized inline comments
- imperative headings, active voice
- added tip about setLocale() reset behavior (null arg)
- fixed incomplete constructor: pivot.Pivot({...}) → pivot.Pivot("#root", {...})
- fixed self-contradictory date example (June vs September, undocumented %u → %S)
- fixed missing comma in en locale object, "the the" typo, comment spacing
- approved code-block intro templates
- imperative headings, active voice, approved code-block intros - fixed wrong link target: headerShape cellStyle linked to tableshape-property → headershape-property - added full marks() function signature (value, columnData, rowData) per API docs - restructured marks section, removed awkward single-item "built-in theme" list - added missing intro descriptions for sections that jumped straight into code
- imperative headings (gerund → infinitive), with {#anchor} pins preserving 9 incoming links
- fixed date-format example: missing format: key
- fixed limits example: id: → field: per config API
- corrected and completed filter conditions list per config API (typos, tab char, missed includes)
- corrected methods description: value is an object with handler, not a function
- split long "Apply formats to fields" section into numeric/date sub-sections
- active voice, approved code-block intros, normalized inline comments
- imperative headings with {#anchor} pins preserving 6 incoming links
- fixed variable redeclaration in expand/collapse example (table → tableInstance)
- corrected method chain: tableInstance.exec → tableInstance.api.exec per Table API
- fixed undefined api and wrong handler signature in custom-left-split example
- replaced italic-formatted default template with proper code block matching API source
- converted intro into canonical API-list format, restructured autoWidth and field-actions lists
- active voice, approved code-block intros, normalized inline comments
- imperative headings, active voice, approved code-block intros - fixed bug: destructure fields and dataset from props (constructor was receiving undefined values) - corrected shell code-block language tags from json/jsx to bash - bold-italic file paths → italic per rules - typo fix: othe → other
- imperative headings, active voice, approved code-block intros - fixed bugs: unclosed <script> tag, missing this. prefix for Vue props (this.fields/this.dataset), undefined table → this.table in event handler - corrected shell code-block language tags from json/jsx to bash - bold-italic file paths → italic per rules - typo fix: othe → other
- imperative headings, active voice, approved code-block intros - fixed bug: missing getData() destructure in event-handling ngOnInit (fields/dataset were undefined) - corrected shell code-block language tags from json/jsx to bash - bold-italic file paths → italic per rules - typo fix: othe → other - replaced exclamation mark in :::note: block
- imperative headings, active voice, approved code-block intros - corrected shell code-block language tags from json/jsx to bash - bold-italic file paths → italic per rules - typo fix: othe → other - normalized spacing and added missing semicolon in skeleton block
- removed gerund from heading - collapsed 4 wordy sentences into 2 concise ones - removed rhetorical question - raw HTML link → Markdown link
- removed "constructor" repetition between adjacent sentences - fixed redundant "HTML container" inside the parameters bullet - removed "instance" repetition in returned-instance description - rewrote "See also how to download packages:" callout
- removed definite article before standalone format names: "in XLSX or CSV format"
- tightened tip's last sentence ("when calling" → direct condition)
- snippet intro uses direct action verb ("exports" instead of "demonstrates exporting")
- removed passive ("is also supported") and folded "method" repetition into a relative clause
- collapsed JSON-mention triple ("convert ... to JSON, then ... native JSON")
- tightened convert() helper parameter descriptions
- removed filler "First," and "demonstrates" snippet intro
- restructured two "By default, ..." sentences to use "default" as adjective - collapsed "locale (the value in the lang field of the locale)" parenthetical - removed "custom" redundancy and "and then" wordiness - snippet intro uses direct action verb
- removed "Pivot" repetition in custom style intro
- collapsed cellStyle return-value clause ("returns a string ... uses the returned string")
- "ships" → "includes" to avoid informal repetition
- moved gerund clause to second part of sentence
- added comma after "e.g."
- restructured two "By default, Pivot ..." sentences - split long filter and date-format snippet intros - "Pivot provides" → "Pivot includes" (overused verb) - removed directional filler "below" before in-page link - snippet intro uses direct action verb
- removed passive + redundant pair "configured or customized" - restructured "By default, fields ..." headerShape paragraph - "is shown by default" → "appears by default" - split long expand/collapse procedure sentence
- removed "Now" filler and "the Pivot component" redundancy - "see Pivot rendered" → "see Pivot render the data" (active verb)
- removed "Now" filler and "the Pivot component" redundancy - "see Pivot rendered" → "see Pivot render the data" (active verb)
- removed "Now" filler and "the Pivot component" redundancy - "see Pivot rendered" → "see Pivot render the data" (active verb) - removed directional filler "below" before step subsections
- removed "Now" filler and "the Pivot component" redundancy - "see Pivot rendered" → "see Pivot render the data" (active verb)
- replaced "out of the box" with "ready to use" per word-choice rules - removed passive "is required" and vague "robust" claim - folded into concrete capability sentence
- grammar and wording fixes across API config/events/methods/table/internal docs - guides and news pages polished for clarity - rename update-value event to update-field (page and references) - restore heading anchors in guides broken by renamed headings
- onEmptyLinkMatch resolved the target from the page directory instead of the docs root, so [](api/...) links stayed empty and unresolved - now resolves from the docs root and emits a root-absolute href without the .md/.mdx extension, matching normalizeMarkdownMdLinks - guard against a missing file or absent sidebar_label to avoid build crash
Rewrite guides using skills
- sidebar and three docs pages referenced non-existent api/events/update-value-event - canonical event is update-field; pointed all links to api/events/update-field-event - fixes build failure (invalid sidebar id) and broken link warnings
[add] Working with server guide
- resolve leftover merge conflict markers in loading-data - split related links into "Related articles" and "Related API" in working-with-server - drop trailing punctuation from list items and simplify API link labels
- configure i18n block in docusaurus.config.js (locales, localeConfigs) - add locale dropdown to navbar and search language array (ko excluded — lunr bug) - scaffold i18n/ translation files for all four locales - translate UI chrome: navbar, footer, sidebar categories, blog options - translate theme strings in code.json (reused from docs-kanban + manual fills) - doc content (.md) stays English fallback until convert step
- add i18n/ to dhx-md-data-transformer-plugin loader include - without it @short/@getshort, admonitions and empty-link resolution were left raw in translated locale builds - matches the working docs-kanban reference config
- translate all 62 docs/*.md into i18n/de current/ - API (45), guides (13), news (2), root pages (2) - copy image assets into the locale tree so build resolves them - add .sync marker at source HEAD 995cefe for future updates - formal "Sie" register, English heading anchors preserved
- translate all 62 docs/*.md into i18n/zh current/ - API (45), guides (13), news (2), root pages (2) - copy image assets into the locale tree for build resolution - add .sync marker at source HEAD 34a2b62 for future updates - formal written Chinese, CJK/Latin spacing, English anchors kept - add a space after a link in news/migration so the dhx loader normalizes both links (CJK adjacency broke link resolution)
- translate all 62 docs/*.md into i18n/ko current/ - API (45), guides (13), news (2), root pages (2) - copy image assets into the locale tree for build resolution - add .sync marker at source HEAD 05469eb for future updates - formal 합니다체 register, English heading anchors preserved - keep a space after a link in news/migration so the dhx loader resolves it (Korean particle adjacency breaks link resolution)
- translate all 62 docs/*.md into i18n/ru current/ - API (45), guides (13), news (2), root pages (2) - copy image assets into the locale tree for build resolution - add .sync marker at source HEAD 44e03f9 for future updates - natural technical Russian, transliterated terms (АПИ, виджет), English heading anchors preserved
- comment out editUrl in preset-classic docs options to remove the "Edit this page" links - minor indentation fix on the search language array
- move the colon outside the bold markers in "Related ..." and export option labels: **Label:** -> **Label**: - fix a stray double colon (**Related articles:**: -> **Related articles**:) - applied to 14 English source files and their Korean translations
- move the full-width colon outside the bold markers in "Related ..." and export option labels: **标签：** -> **标签**： - aligns zh with the English source, de, ru and ko locales - 18 labels across 14 Chinese translation files
- replace Cyrillic "АПИ" with "API" in description frontmatter - affects ~62 localized ru documentation pages
Translate documentation
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.
No description provided.