Skip to content

Latest commit

 

History

History
46 lines (34 loc) · 2.6 KB

README.md

File metadata and controls

46 lines (34 loc) · 2.6 KB

Solodev CMS Documentation

Source for the Solodev CMS documentation site, built with Retype and published to cms.solodev.net.

Browse the docs

Section What's there
Quickstart Deployment guides for CMS Micro, Pro, Enterprise, and CMS for EKS
Websites Adding a website, managing files/folders/pages, website settings
Modules The prebuilt module catalog (Blog, Calendar, Datatable, and more) and building your own
Forms Contact forms and custom Module Forms
Documents The standalone file repository, separate from any website
Engage Segments, File Groups, Scheduler, Experiments
Organization Users, Groups, Contacts, Agents
Admin Settings, APIs, and platform-wide configuration
Providers Connecting the CMS to outside services (Git hosts, SSL, CDN, CRM, and more)
Shortcodes The full shortcode reference
Support Tasks and other support tooling
Release Notes Version history

Working on the docs locally

npm install
npx retype start

Serves a live preview (URL printed in the terminal -- pass --port <number> to pin one) with hot reload on save. A Retype key is required to preview past the 100-page free limit -- add yours to a local .env as RETYPE_KEY=... (never commit it; it's already git-ignored), or register it once with:

npx retype wallet --add YOUR_KEY

Deploying

Deployment is handled by .github/workflows/workflow.yml -- it builds with Retype and syncs the static output to the cms-documentation S3 bucket. It only runs on version tags (v*), not on every push to master. To ship a change that's already on master:

git tag v11.9
git push origin v11.9

Content structure

Each page is a folder under src/ containing an index.md (content) and index.yml (nav order, icon, and title). Folder nesting mirrors the left nav exactly -- a subfolder becomes a child page. See any existing page for the conventions in use (image paths, tables, !!! Note: / !!! Tip: callouts, {% tabs %} blocks).