onlyoffice-docs
/onlyoffice-docs
Przeszukuje dokumentację API ONLYOFFICE i sprawdza, czy produkcja serwuje pliki Markdown, przy pisaniu referencji do SDK.
- Autor
- ONLYOFFICE ↗
- Repozytorium
- agent-skills ↗
- Licencja
- Apache-2.0
- Ostatnia zmiana repozytorium
- 29.10.2026
Ocena i bezpieczeństwo
- Pliki w paczce
- 3
- Skrypty
- 2
- Komentarze HTML
- 0
- Adresy URL w SKILL.md
- 0
Brak sygnałów. Repozytorium zmienione 29.10.2026, bez odwołań do wycofanych modeli i API.
Apache-2.0, otwarta: można używać i zmieniać, z zachowaniem licencji i informacji o zmianach.
- 2 skrypty w paczce. Przejrzyj je przed instalacją, bo Claude może je uruchomić.
Skrypty: scripts/docs.mjs, scripts/test-docs.mjs
Co robi i kiedy
Przeszukuje dokumentację API ONLYOFFICE i sprawdza, czy produkcja serwuje pliki Markdown, przy pisaniu referencji do SDK.
Oryginalny opis (EN)
Navigate the ONLYOFFICE API documentation (api.onlyoffice.com, or the docs stand for a section production does not serve yet) while working on the skills of this repository: find the page that states a signature, field, default, enum value, endpoint or event, print it or one heading of it, and check whether production serves the Markdown docs at all. Use when writing or correcting a reference of apps-embed-sdk, apps-plugin-sdk or apps-ui-kit, when a claim in a skill must be checked against the docs, when a reference needs a docs link, when deciding whether a passage duplicates the docs and can
Jak działa
- Working rules
- What is where
Podgląd SKILL.md
---
name: onlyoffice-docs
description: >
Navigate the ONLYOFFICE API documentation (api.onlyoffice.com, or the docs stand for a
section production does not serve yet) while working on the skills of this repository: find the
page that states a signature, field, default, enum value, endpoint or event, print it or one
heading of it, and check whether production serves the Markdown docs at all. Use when writing
or correcting a reference of apps-embed-sdk, apps-plugin-sdk or apps-ui-kit, when a claim in a skill must be checked
against the docs, when a reference needs a docs link, when deciding whether a passage
duplicates the docs and can become a pointer, or when someone asks "is the documentation live
on production", "what does the docs page for X say", "find the docs page about Y".
Repository-internal; not shipped in the plugin.
allowed-tools: Bash(node ${CLAUDE_SKILL_DIR}/scripts/docs.mjs *)
---
# Navigate the ONLYOFFICE API documentation
The docs site publishes every page as Markdown (`<page-url>.md`) and an index per section
(`<section>/llms.txt`). `scripts/docs.mjs` reads them from production (`apiSite` in the root
`sources.json`) and, for a section production does not serve yet, from the stand (`apiSiteFallback`).
The shipped skills describe the site by URL and never depend on this script; this script is how
their authors check what the site says.
```
node .claude/skills/onlyoffice-docs/scripts/docs.mjs status # production vs stand, per section
node .claude/skills/onlyoffice-docs/scripts/docs.mjs sections # the sections of the site
node .claude/skills/onlyoffice-docs/scripts/docs.mjs find uploader mode --section embed-sdk # pages whose title, URL or summary contain every word
node .claude/skills/onlyoffice-docs/scripts/docs.mjs page TFrameConfig # a type name, a site path (docspace/…, no leading slash) or a URL
node .claude/skills/onlyoffice-docs/scripts/docs.mjs page SDKInstance --toc # headings only, then --heading <text> for one part
node .claude/skills/onlyoffice-docs/scripts/test-docs.mjs # offline self-test of the parsers
```
Section aliases for `--section`: `apps-embed-sdk` or `embed-sdk`, `apps-plugin-sdk` or `plugins-sdk`,
`apps-ui-kit` or `ui-kit`, `rest`, `mcp`, `docs-api`,
`office-api`, `plugins`, `macros`, `ai`, `document-builder`, `desktop`. `--host <origin>` pins a
site (a local docs build); `--refresh` bypasses the one-hour cache.
## Working rules
1. **Search before you fetch.** `find` costs one index read; a `page` read costs the page (the
generated reference pages run from 2 KB to 40 KB). Take `--toc` first and `--heading <text>`
for the part you need. When no page carries every word, `find` lists the closest ones by
words matched — a page title (`Uploader mode`, `TFrameEvents`) is the most reliable query.
2. **Read the first output line.** `FALLBACK` means the stand answered because production does
not serve that page. `generated from: … (branch X)` on a reference page names the source
branch the page was generated from — compare it with the branch the skill targets before
treating a difference as a documentation error.
3. **A skill passage that repeats a docs page is a pointer, not a copy.** When `page` shows the
same field table or signature the reference carries, the reference keeps only what the page
does not say — the portal's behaviour, the trap, the silent failure — and links the page.
A link goes into the text as a production URL (`apiSite`), never a stand URL; run
`node tools/sync-sources.mjs --check` afterwards.
4. **When the docs and a skill disagree**, check the SDK source the page was generated from and
the client before changing either; a docs page generated from an older branch is stale, not
wrong, and a hand-written guide page (`embedding-modes/*`, `samples/*`) can lag the SDK.
5. **`status` is a release gate** (RELEASING.md step 2b): exit 0 means production serves
`llms.txt` and a Markdown page for every section; 1 means only the stand does; 2 means neither.
## What is where
- `docspace/javascript-sdk` (Embed SDK): guides under `embedding-modes/*` and `get-started/*`,
the generated reference under `usage-sdk/{classes|type-aliases|enumerations|variables}` (a type
or class name is its page name), samples under `samples/*`.
- `docspace/plugins-sdk` (Plugins SDK): `usage-sdk/coding-plugin/{interfaces,react,enums}` — an
interface (`IContextMenuItem`) or an enum (`Actions`) is its page name.
- `docspace/api-backend` (REST API): one page per operation; `find` with the resource and the
verb (`find rooms create --section rest`).
- `docspace/ui-kit` (UI kit): `getting-started/*` for installation, themes, translation, hooks,
utils, constants and structure; one page per component under `ui/<group>/<slug>`
(`ui/overlays/aside`, `ui/form-controls/text-input`) — the group is the Storybook group, so
`find` by the component's name rather than guessing it; `components/*` is the portal's
composites (selectors, errors, providers), not the components.
- `docs/*`: the ONLYOFFICE Docs editor family — Docs API, Office API, editor plugins and macros,
Document Builder, Desktop Editors.
Pliki w paczce (3)
- SKILL.md 5 KB
- scripts/docs.mjs 24 KB
- scripts/test-docs.mjs 7 KB
Wersje
W bazie nie ma innych skilli o nazwie onlyoffice-docs.
Migawka bazy z 13.11.2026 · wersja paczki db1c1aa42321 (skrót SHA-256 całej paczki)
Pobrania w ostatnich 30 dniach: 0 · ranking
Zgłoś problem z tym skillem: szkodliwa treść, błędny opis albo prośba autora o usunięcie.
Podobne skille
- 100apps-plugin-sdk
Buduje, sprawdza i opisuje wtyczki ONLYOFFICE Apps powstałe przez Plugins SDK, np. pozycje menu, strony w panelu i obsługę zdarzeń. - 100apps-embed-sdk
Osadza aplikacje ONLYOFFICE w aplikacjach webowych przez Embed SDK, z menedżerem plików, edytorem, uwierzytelnianiem i zdarzeniami. - 95product-docs
Przeszukuje przewodniki produktu Straddle, np. o testach w sandboxie, zgodności i cyklu płatności, bez referencji SDK. - 100generating-api-docs
Tworzy dokumentację API z przykładami, przewodnikami uwierzytelniania i SDK. - 100generating-api-docs
Tworzy dokumentację API z przykładami, przewodnikami uwierzytelniania i SDK. - 100write-docs
Pisze strony przewodników w docs.sodax.com tak, by nie rozjechały się z SDK, z przykładami kompilowanymi i sprawdzeniami.