You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Our docs are already indexed by Context7 as /diplodoc-platform/docs, but the index was created without any configuration from our side. This PR takes control of how the library is parsed.
context7.json
Indexes only the en tree. Both languages carry the same code examples, so indexing ru as well doubled every snippet in the agent context. Three guides exist only in ru so far (multilingual-projects, pdf-styles, the supported-languages include); they will show up once translated.
Excludes _assets, _images, .github and the repository README.
Adds rules: short YFM guidelines that Context7 shows to coding agents next to the snippets (closed blocks, relative .md links, toc.yaml, multiline tables, what is not enabled by default, how to build).
Refresh workflow
.github/workflows/context7-refresh.yml calls the Context7 refresh API on every push to master, so the index follows the docs instead of waiting for the popularity-based schedule (45 days for our rank). It needs the CONTEXT7_API_KEY repository secret; until it is set the job fails harmlessly.
Follow-ups outside the repo: claim the library in the Context7 dashboard (adds url and public_key to this file) and trigger a manual refresh once this is merged so the new configuration applies.
⚠️ en/guides/openapi.md: 168: YFM001 / inline-code-length Inline code length [Expected: 100; Actual: 265] [Context: " — the specification is displayed directly on the page (default value). If the size of the specification's json schema exceeds the value of ##maxOpenapiIncludeSize## (100 KB by default), the mode automatically switches to "]
⚠️ en/tools/docs/build.md: 52: YFM001 / inline-code-length Inline code length [Expected: 100; Actual: 109] [Context: " — a snapshot of the dependency graph (pages, included files, assets, missing paths, edge count), as well as "]
⚠️ en/guides/openapi.md: 168: YFM001 / inline-code-length Inline code length [Expected: 100; Actual: 265] [Context: " — the specification is displayed directly on the page (default value). If the size of the specification's json schema exceeds the value of ##maxOpenapiIncludeSize## (100 KB by default), the mode automatically switches to "]
⚠️ en/tools/docs/build.md: 52: YFM001 / inline-code-length Inline code length [Expected: 100; Actual: 109] [Context: " — a snapshot of the dependency graph (pages, included files, assets, missing paths, edge count), as well as "]
⚠️ en/guides/openapi.md: 168: YFM001 / inline-code-length Inline code length [Expected: 100; Actual: 265] [Context: " — the specification is displayed directly on the page (default value). If the size of the specification's json schema exceeds the value of ##maxOpenapiIncludeSize## (100 KB by default), the mode automatically switches to "]
⚠️ en/tools/docs/build.md: 52: YFM001 / inline-code-length Inline code length [Expected: 100; Actual: 109] [Context: " — a snapshot of the dependency graph (pages, included files, assets, missing paths, edge count), as well as "]
⚠️ en/guides/openapi.md: 168: YFM001 / inline-code-length Inline code length [Expected: 100; Actual: 265] [Context: " — the specification is displayed directly on the page (default value). If the size of the specification's json schema exceeds the value of ##maxOpenapiIncludeSize## (100 KB by default), the mode automatically switches to "]
⚠️ en/tools/docs/build.md: 52: YFM001 / inline-code-length Inline code length [Expected: 100; Actual: 109] [Context: " — a snapshot of the dependency graph (pages, included files, assets, missing paths, edge count), as well as "]
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
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.
Our docs are already indexed by Context7 as /diplodoc-platform/docs, but the index was created without any configuration from our side. This PR takes control of how the library is parsed.
context7.json
entree. Both languages carry the same code examples, so indexingruas well doubled every snippet in the agent context. Three guides exist only inruso far (multilingual-projects,pdf-styles, thesupported-languagesinclude); they will show up once translated._assets,_images,.githuband the repository README.rules: short YFM guidelines that Context7 shows to coding agents next to the snippets (closed blocks, relative.mdlinks, toc.yaml, multiline tables, what is not enabled by default, how to build).Refresh workflow
.github/workflows/context7-refresh.ymlcalls the Context7 refresh API on every push tomaster, so the index follows the docs instead of waiting for the popularity-based schedule (45 days for our rank). It needs theCONTEXT7_API_KEYrepository secret; until it is set the job fails harmlessly.Follow-ups outside the repo: claim the library in the Context7 dashboard (adds
urlandpublic_keyto this file) and trigger a manual refresh once this is merged so the new configuration applies.