Next#38
Merged
Merged
Conversation
- restructure headings to imperative sentence case and split long sections into focused subsections - reformat API lists with linked names and em-dash descriptions - add intro sentences before every code block, normalize inline comments - replace passive voice, gerund openers, and future tense with active present simple - fix formShape example: type -> comp to match API - add Optimize rendering of large datasets section covering renderType
- convert headings to imperative sentence case, add short descriptions under each - add intro sentences before every code block - replace passive voice and "you need to" phrasing with active present simple - reformat parameter lists with em-dash descriptions - fix broken link to properties overview, replace bold API names with backticks
- split flat content into Prepare a sample dataset, Load data from a local file, and Update data after initialization sections - add intro sentences before every code block - replace passive voice and gerund openers with active present simple - reformat Related articles list with linked API names and em-dash descriptions - add Update data after initialization section covering setConfig() with fetch example - add tip cross-linking renderType for large datasets
- split Applying locales into Apply a built-in locale, Apply a custom locale, and Reset to the default locale sections - convert headings to imperative sentence case, add short descriptions under each - add intro sentences before every code block including those inside details blocks - replace passive voice and gerund openers with active present simple - reformat Related articles list with em-dash descriptions - add Reset to the default locale section covering setLocale() and setLocale(null) - fix worked example in date/time format section: %u replaced with %S (verified against widget source: @wx/lib-dom case %S returns milliseconds, %u token does not exist), June replaced with September to match 2024-09-20 in the example
- convert headings to imperative sentence case, add intro paragraph at the top - add intro sentences before every code block - replace passive voice and gerund openers with active present simple - reformat Related articles list with linked API names and em-dash descriptions - document the setConfirmHandler callback shape (slot, data, confirm fields) inline before the example - add info block on confirm-slot event as an alternative to setConfirmHandler - replace prose-only g2l/l2g description with a typed list
- convert headings to imperative sentence case, add intro paragraph at the top - add intro sentences before every code block - replace passive voice and "you need to" phrasing with active present simple - fix Default style section: replace pivot-* variables (copy-paste from Pivot docs) with real booking-* variables sourced from the widget code (Layout.svelte, Slots.svelte) - fix invalid link tag: type="stylesheet" replaced with rel="stylesheet"
- convert headings to imperative sentence case, add short intros under each - add intro sentences before every code block - replace passive voice and "you need to" phrasing with active present simple - fix events example: invalid date property replaced with start (verified against api/config — booking has start and end, no date) - add cross-link to loading-data guide and data API in the data section - replace bold/italic API references with backticks, normalize inline code comments
- convert headings to imperative sentence case, add short intros under each - add intro sentences before every code block - replace passive voice and "you need to" phrasing with active present simple - add cross-link to loading-data guide and data API in the data section - replace bold/italic API references with backticks, normalize inline code comments
- convert headings to imperative sentence case, add short intros under each - add intro sentences before every code block - replace passive voice and "you need to" phrasing with active present simple - fix unclosed script tag in trial-version import example - fix stray comma in Booking constructor inside mounted() example - fix undefined booking variable in event subscription example (booking -> this.booking) - add cross-link to loading-data guide and data API in the data section - replace bold/italic API references with backticks, normalize inline code comments
- convert headings to imperative sentence case, add short intros under each - add intro sentences before every code block - replace passive voice and "you need to" phrasing with active present simple - add cross-link to loading-data guide and data API in the data section - replace bold/italic API references with backticks, normalize inline code comments
- convert bold rule labels (Rule 1-7) to ### headings in imperative sentence case - rewrite section headings (Main concepts, Example, conversion rules) to imperative - add intro sentences before every JSON code block - replace future tense and passive voice with active present simple - format the slot strategies list with linked data API names - fix internal cross-link anchors after heading renames; link Rule 7 reference - remove trailing blank lines at EOF
- convert bold rule labels (Rule 1-7) to ### headings in imperative sentence case - rewrite section headings (Main concepts, Example, conversion rules) to imperative - add intro sentences before every JSON code block - replace future tense and passive voice with active present simple - format the slot strategies list with linked data API names - fix internal cross-link anchors after heading renames; link Rule 7 reference - remove trailing blank lines at EOF
- reword "Converting events to slots is the core..." to "Event-to-slot conversion is the core..." in eventcalendar and scheduler guides - grammar review found gerund subject openers; rest of the 12 guides clean
- themeConfig: og:image (1200x630), og:type=website, og:site_name, og:locale, twitter:card, twitter:site - StructuredData component: emits TechArticle for guides, APIReference for /api/*, SoftwareApplication for site root - DocItem/Metadata swizzle adds twitter:title/description (not emitted by Docusaurus PageMetadata) and JSON-LD - og-default-booking.png placed in static/img/
- rename shadowing `booking` variable to `widget` in samples - fix template param `card` to `item` in configuration guide - fix review property `star` to `stars` in dataset examples - fix selected date class `.selected` to `.wx-selected` - use `var(--wx-border)` for booking separator variable - clarify setConfirmHandler relation to confirm-slot event
- cardShape: default subtitle is true, not false - cardTemplate: rename param card to item in text and samples - data: mark slots optional, fix availableSlots shape to [timestamp, duration][] - data: fix review property star to stars - filterShape: suggest is optional, not required - formShape: wrap usage in array, fix type to comp in example - locale: fix shadowing booking var to widget, use booking.locales.de
- confirm-slot example: obj.id -> obj.slot.id (payload is { slot, data, confirm })
- select-item-date @short: now reflects date selection, not item selection
- fix "abject" typo in confirm-slot parameters
- rename const booking -> widget in examples to avoid shadowing the global namespace
- setConfig example: drop the extra `config` wrapper, pass props directly - setLocale: use booking.locales.de instead of undefined `de`, fix Usage notation - serialize Usage: return type [] -> object[] - rename const booking -> widget in examples to avoid shadowing the global namespace
- getReactiveState example: state.cards -> state.data (no `cards` key in state) - exec example: drop the extra `filterData` wrapper, pass filter values directly - detach: fix non-existent `open-filter` event mention -> select-slot - getState/getReactiveState: add missing state fields start/end/renderType, refine selectedSlot comment - rename const booking -> widget in examples to avoid shadowing the global namespace
- convert absolute links (/api/config/booking-data) to the project's docs-root-relative .md form (api/config/booking-data.md) expected by the dhx-md-data-transformer loader - fix 4 stale anchors after configuration.md rewrite (defining->define, configuring->configure) - leave overview empty-text links, assets, /category routes and external links untouched - verified with yarn build: 0 broken links
- rewrite overview empty links to docs-root-relative form ([](api/config/booking-data.md)) to match pivot and the normalizeMarkdownMdLinks convention - update onEmptyLinkMatch in docusaurus.config.js to resolve targets from the docs root and emit a root-absolute href without .md, so the sidebar_label text fills in (tables rendered empty otherwise) - add i18n folder to the transformer plugin include, matching pivot - verified with yarn build: 0 broken links, all overview tables filled
- replace bold with backticks for API names: config properties, parameters, events, helpers and method properties - replace bold with backticks for literal values (true/false/text/textarea) - normalize "Related articles" label so the colon sits outside the bold
- exec: return type void -> Promise, note async behavior - on/intercept: document optional config arg with tag (used by detach) - formShape: document validation and errorMessage fields - confirm-slot: data value type any -> string - cardShape: clarify category param wording
- configuration: slot range is six days (four on narrow screens), not five (DATE_RANGE=6) - angular: drop placeholder link on destructor() mention - react: use npm start for CRA dev server instead of npm run dev - localization: minutes/seconds format range starts at 00, not 01
Address valid review comments (code-correspondence, typos, accuracy):
- index.md: fix category description (was duplicate of subtitle); slots window is six days (four on mobile), not the current month
- api-overview: constructor container is `HTMLElement | string`, not only an ID
- getState/getReactiveState: filterValues comment date (was data); note reactive fields are writable stores
- filter-data event: text/date/time are optional; date is a {start,end} struct; add time `label`
- filterShape: `id` is a card field name, not a card id
- data.md: simplify overlap note; reword timestamp wording (absolute ms, local wall-clock)
- setConfig: clarify shallow top-level merge (no deep merge)
- timestamps wording in slot/select events
- how-to-start: typo (you), rename leftover instance to widget, drop marketing line
- experiece -> experience in all 4 integration guides
- loading-data: define getDate() helper; "one data array" wording
- saving-reservations: "card data"
- setNext: align comment with variable name; sharper @short
- styling: "may change"; content-padding via h-padding var; note responsive sizing
- setConfirmHandler @short
- dev-server ports: Angular 4200, Svelte/Vue (Vite) 5173 (React/CRA stays 3000)
- simplify template wrappers to template(fn) (kept `item` prop, not reverted to `card`)
- code-fence languages: bash for shell commands, ts for Angular TS snippets (JSON conversion blocks in scheduler/eventcalendar guides left as json) - internal API page titles: add () to match the methods/ convention (getState() Method, exec() Method, etc.); trim trailing space in on.md - detach page: section headings ## -> ### to match the other internal pages - Angular guide: add npm commands alongside yarn (parity with other guides)
Addresses a PR #35 review comment on wording.
- index.md: "optimised"->"optimized", drop double space, reword the "Making an appointment" cross-reference and add the missing period - align wording: "the filter", "apply a filter at initialization", unify the "internal events can be found here" sentence, fix "slot reservations" link text - cardTemplate: add missing "?mode=result" to the snippet iframe - end: mark the Date parameter as "(optional)" to match start - overview: normalize methods and Event Bus h1 to match sidebar labels - strip trailing whitespace, add final newlines, trim trailing blank lines across docs (no locale/theme content changed)
- comment out editUrl in docusaurus.config.js - removes the "Edit this page" link from the docs pages
Rewrite guides using skills
- docusaurus.config.js: i18n block (locales en/ru/de/zh/ko), locale dropdown in navbar, search language array (ko excluded due to lunr-languages regex bug) - scaffolding for all locales: code.json, navbar.json, footer.json, current.json + empty doc dirs for future article translations - translated navbar titles, footer labels and sidebar category labels; shared labels reused from docs-pivot, theme strings from Docusaurus
- translated all 50 docs/*.md articles into German under i18n/de/.../current (api, guides, root pages, news) - headings translated with original English anchors preserved; code, API names, brands and @getshort macros left intact - copied docs/assets images into the locale folder so relative image links resolve - added .sync marker (HEAD 5d5226c) for future update runs - builds clean: yarn build --locale de
- translated all 50 docs/*.md articles into zh under i18n/zh/.../current (api, guides, root pages, news) - headings translated with original English anchors preserved; code, API names, brands and @getshort macros left intact - copied docs/assets images into the locale folder so relative image links resolve - wrote bare localhost URLs as markdown links in 4 guides, since a fullwidth period touching a bare URL breaks the MDX build - added .sync marker (HEAD 6ccca0c) for future update runs - builds clean: yarn build --locale zh
- translated all 50 docs/*.md articles into ko under i18n/ko/.../current (api, guides, root pages, news) - headings translated with original English anchors preserved; code, API names, brands and @getshort macros left intact - copied docs/assets images into the locale folder so relative image links resolve - rewrote bare localhost URLs as plain markdown links in 4 guides; a Hangul particle/paren touching a bare URL breaks the MDX build - added .sync marker (HEAD 13b0c98) for future update runs - builds clean: yarn build --locale ko
- translated all 50 docs/*.md articles into ru under i18n/ru/.../current (api, guides, root pages, news) - headings translated with original English anchors preserved; code, API names in code, brands and @getshort macros left intact - technical terms transliterated per ru rules (API -> АПИ, callback -> калбэк, widget -> виджет) - copied docs/assets images into the locale folder so relative image links resolve - added .sync marker (HEAD 5e43624) for future update runs - builds clean: yarn build --locale ru
- replace filename-only image alt with descriptive, localized SEO alt text across all locales (en/ru/de/zh/ko) - give main.png context-specific alt (overview vs how-to-start) and trial-booking.png framework-specific alt (React/Vue/Svelte/Angular) - move all images from docs/assets to static/img (single shared copy) - repoint markdown image refs to root-absolute /img/... paths - remove duplicate per-locale i18n assets folders (20 files) - builds clean for all locales
Add translations
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.