docs(arch): Diátaxis restructuring and v0.6.1 stable synchronization#17
Merged
PythonWoods-Dev merged 13 commits intomainfrom Apr 21, 2026
Merged
docs(arch): Diátaxis restructuring and v0.6.1 stable synchronization#17PythonWoods-Dev merged 13 commits intomainfrom
PythonWoods-Dev merged 13 commits intomainfrom
Conversation
Comprehensive update to align documentation with the v0.6.1 stable release and the findings of the Guardians of Quality audit. Changes: - Engines Guide: Added technical notes on Docusaurus v3 versioning logic. - Engines Guide: Documented @site/ alias and absolute slug behavior. - Engines Guide: Explained Smart Collapsing (README and Folder-name patterns). - Commands Guide: Updated --offline flag descriptions for all check commands. - Bilingual Parity: Fully synchronized all changes in Italian (i18n). - Legal: Fixed REUSE compliance for tsconfig.json and SVG assets. All documentation now reflects the 'Structural Custodian' philosophy.
Creates docs/index.mdx as the Docusaurus-native index for /docs/, resolving the 404 reported in Google Search Console. Provides a navigation table linking to all major doc sections. Italian translation added at i18n/it/.../current/index.mdx. Fixed community/contribute link to use explicit relative path.
…contract [EN+IT] - writing-an-adapter.mdx: add provides_index() to Common Methods table and contract invariant #10 (sole method allowed to perform disk I/O) - architecture-overview.mdx: update BaseAdapter protocol block with provides_index(); add provides_index() bullet to key methods list; add 'Alias Mapping in InMemoryPathResolver' section (#alias-mapping) documenting @site/ virtual prefix resolution Italian translations updated in parallel.
New docs/internals/findings-codes.mdx — authoritative index of all Zenzic finding codes with severity, exit code impact, and remediation guidance. Includes dedicated MISSING_DIRECTORY_INDEX section (#missing-directory-index) with engine-aware index detection table and remediation examples. IT: 'Integrità dell'\''Indice di Directory' IT translation at i18n/it/.../current/internals/findings-codes.mdx.
Adds find_missing_directory_indices to the scanner module members list in docs/internals/reference/api.mdx.
- usage/index.mdx: replace tip box with Install->zenzic lab->check all flow - usage/index.mdx: strip --pre from all Tabs install snippets - guides/index.mdx: uvx --pre -> uvx in zero-config tip - guides/ci-cd.mdx: strip --pre from all GitHub Actions and GitLab CI snippets - .github/workflows/ci.yml: uvx --pre -> uvx in Zenzic audit step - All changes mirrored in i18n/it/ v0.6.1 'Obsidian Glass' is stable. zenzic lab is the recommended onboarding path.
…a 027] CEO Direttiva 027 'Precision over Magic' — apply to all doc pages. Replace 'auto-detects'/'rileva automaticamente' with precise language: EN (5 files): - docs/guides/engines.mdx: 'auto-detects' -> 'deterministically discovers the engine:' - docs/guides/adapters-config.mdx: '## Adapter auto-detection' -> '## Adapter discovery (file-driven)' 'automatically from' -> 'deterministically resolves' - docs/usage/index.mdx: 'auto-detects the documentation engine' -> 'identifies the documentation engine from its configuration files' - docs/index.mdx: '# (auto-detects engine)' -> '# (discovers engine from config files)' - docs/guides/core-settings.mdx: 'auto-detects all non-default locales from' -> 'reads all non-default locales from' IT (5 files — bilingual parity): - Corresponding changes in i18n/it/docusaurus-plugin-content-docs/current/
…xis Phase 1+2 [EN+IT] - Ghost Shift: 29 EN + 29 IT files moved to Tutorials / How-to / Reference / Explanation quadrants (git history preserved as renames) - Developer sub-hierarchy relocated from internals/ → community/developers/ with nested Diátaxis sub-quadrants (tutorials/, how-to/, reference/, explanation/) - All internal cross-references healed in EN and IT (links, reference definitions, table hrefs) - sidebars.ts: switched to type:autogenerated — eliminates orphan ID risk on future moves - _category_.json: unique translation keys added to developer sub-categories to resolve Docusaurus duplicate-key conflict - Hero button: /docs/intro → /docs/ (D034 Unified Gateway) - docs/index.mdx: sidebar_position 0, table links updated to new paths - zenzic.toml: CORE SETTINGS / EXTERNAL VALIDATION / PROTEZIONE DOGFOODING / GESTIONE ASSET / ENGINE CONTEXT sections with inline reference comments - Build: SUCCESS (EN + IT, onBrokenLinks:throw)
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.
Complete reorganization of the Zenzic documentation following the Diátaxis framework.
Changes: