Skip to content

Documentation Site

Source of Truth

The source of truth for documentation is the GitHub repository:

https://github.com/uaskpro/shop-theme

Markdown files live in /docs. Documentation changes continue to use the normal branch, PR, review, and merge workflow.

Public Domain

The public documentation domain is:

https://docs.opencart.link/

Use docs plural.

Build Tool

The documentation site uses MkDocs Material.

Reasons:

  • Markdown-first;
  • static output;
  • fast builds;
  • good navigation and search;
  • suitable for architecture, product, and operations docs.

Do not use WordPress, OpenCart, a custom CMS, a heavy frontend framework, or a database-backed documentation system for this site.

Deployment Options

Manual Server Build

Build on the server and copy the generated site/ directory to the web document root. This is simple, but easy to forget and not ideal for repeatable publishing.

GitHub Actions Deploy via SSH

Recommended option once deploy credentials are approved. GitHub Actions builds the static site after documentation changes are merged, then deploys generated files to a server directory over SSH.

Static Hosting

The generated static site can be hosted by any static hosting provider that supports custom domains.

Use GitHub Actions build plus deploy to a server directory for docs.opencart.link.

Do not configure deploy secrets in this PR. DNS and web server setup should be handled as OPS work.

Brand Site Boundary

docs.opencart.link is documentation. shop-theme.com is reserved for a polished public product website later.

Deployment Rules

  • GitHub /docs remains the source of truth.
  • Public HTML is generated output, not editable source.
  • All documentation edits go through PR review.
  • No database.
  • No CMS.
  • No OpenCart install for documentation.