dmi3yy/ddocs

File-first documentation browser for Evolution CMS manager.

Maintainers

👁 dmi3yy

Package info

github.com/Dmi3yy/dDocs

Type:evolutioncms-module

pkg:composer/dmi3yy/ddocs

Statistics

Installs: 15

Dependents: 0

Suggesters: 0

Stars: 0

Open Issues: 1

v1.0.0 2026-05-14 16:37 UTC

Requires (Dev)

None

Suggests

None

Provides

None

Conflicts

None

Replaces

None

GPL-3.0-only 29a79ea2a7e7337123ce63272ce7cc2db613ff4e

  • Dmytro Lukianenko <dmi3yy.woop@evo.im>

documentationmarkdowndocsevocmsevolution-cms

This package is auto-updated.

Last update: 2026-06-14 18:48:35 UTC


README

dDocs is the file-first documentation browser and documentation standard surface for Evolution CMS manager packages. It discovers package Markdown, builds a safe tree, renders documents in the manager, and keeps project-owned notes as files.

Languages

Each supported dDocs language folder contains:

  • README.md - localized overview and navigation.
  • user-guide.md - manager user workflows and visible behavior.
  • developer-guide.md - architecture, package integration, routes, and checks.

Additional files are conditional. dDocs includes configuration.md, reference.md, troubleshooting.md, and frontend-guide.md because it has settings, routes, a file index, and a browser viewer runtime.

Locale Status

Locale Status Notes
en complete Canonical source for package docs.
uk complete Canonical Ukrainian locale.
pl complete Localized release pages exist, terminology still follows shared technical names.
de complete Localized release pages exist, terminology still follows shared technical names.
fr complete Localized release pages exist, terminology still follows shared technical names.

Read This First

Reader Start here
Manager user User Guide
Package developer Developer Guide
Documentation contributor Contributing To Documentation
AI agent AI And Agent Readiness

Language Policy

Ukrainian documentation uses uk only. Legacy Evolution manager values such as ua are normalized internally to uk; do not create docs/ua, list ua as a documentation locale, or add ua to docs manifests.

Canonical Guides

Package Documentation Contract

New Evolution packages should use a lowercase docs/ root:

docs/
 README.md
 assets/
 images/
 diagrams/
 en/
 README.md
 user-guide.md
 developer-guide.md
 uk/
 README.md
 user-guide.md
 developer-guide.md

The minimum user-facing locale set is English, Ukrainian (uk), Polish, German, and French. Packages may keep Russian as a legacy extra when they already ship it.

dDocs Navigation Contract

  • All package entrypoints must stay inside this docs/ tree.
  • Localized READMEs are navigation and onboarding pages, not generated task logs.
  • Internal links must be relative and must resolve inside the package source.
  • Code fences must include language identifiers so dTui and Prism can highlight and copy them consistently.
  • Images must live under docs/assets/images/ or another path inside the docs root. dDocs blocks paths that escape safe roots.
  • Old generated documentation sites should move to docs_old/ so dDocs does not index Docusaurus, Jekyll, build config, or generated static files.