Write in the editor and publish

1. Overview & Business Value#

This comprehensive operational guide details the architecture, business workflows, configuration parameters, and execution steps for Write in the editor and publish within SmartERP.

Pages can be written in two ways. Markdown pages come from the documentation files. Rich-text pages are written in Odoo's editor, with no code at all. Both are classified, reviewed, published, searched and shown the same way.

{screenshot:write-and-publish-overview-dashboard}

2. Prerequisites & Security Access Groups#

• Required Modules: smarterp_docs
• Security Groups:
  • Technical Documentation Architect (Technical ID: base.group_system)
  • Enterprise User (Technical ID: base.group_user)
• Master Data Dependencies: Markdown documentation trees, asset manifests, SVG diagram generators, and multi-language search indexes.

3. Step-by-Step Configuration & Execution#

Step 1: Navigating to the Module Interface#

1. Log into your SmartERP instance at https://smarterp.et/odoo.
2. Open the main App Switcher (grid icon in the top-left corner).
3. Select the Documentation Portal app icon.
4. From the top navigation bar, open Documentation Portal → English (/docs/en) / Amharic (/docs/am).

{screenshot:write-and-publish-app-switcher-navigation}

Step 2: Creating and Parameterizing Records#

1. Click the New button in the top-left control panel.
2. Complete the mandatory fields in the record form:
   • Page Title (Mandatory): Standardized title conforming to Diátaxis framework
   • Summary (Mandatory): Concise operational summary describing page intent
   • Diátaxis Type (Mandatory): Valid classification (how_to, tutorial, concept, reference, admin_guide)
3. Configure optional operational parameters and localized tags as required:
   • Audience (Optional): Designated user roles (Accountants, Engineers, Administrators)
   • Difficulty Level (Optional): beginner, intermediate, or advanced
4. Click the Save icon in the control bar to commit the record.

{screenshot:write-and-publish-record-creation-form}

Step 3: Validating and Processing Transactions#

• State Transitions: Execute operational state progression (Authoring → Local Offline Test Validated → Manifest Registered → Published Live).
• Ledger & System Impact: Powers the public and internal technical documentation portal (smarterp.et/docs) with sub-second rendering and dual-theme visual diagrams.
• Audit Verification: Automated recording of author ID, timestamp, and immutable revision history.

{screenshot:write-and-publish-transaction-processing-state}

The editor#

Create a page in Documentation → Pages and choose Rich text. In the editor you can use headings, lists, tables, links, images and the / menu for banners (note, tip, warning, caution), code and videos. Paste text from a word processor and it is cleaned.

What is saved is checked again on the server and rebuilt from an allow-list, so a page can never carry a script, a form, an event handler or a link that runs code. Videos from YouTube, Vimeo and Loom become a player; no other embed is allowed.

Link to another page with the link tool and an address of the form doc:section/page. Images are stored with the page.

The life of a page#

draft → in review → approved → published → needs review → deprecated → archived

Move a page with the buttons at the top of its form. Every move is written in the page's history, and a person who is asked to act gets an activity. Each publication keeps a snapshot you can restore as a new draft, under Publications.

Who may do what#

Give people these roles under Settings → Users → Documentation. An author cannot publish by writing the state field: only the buttons move a page, and each one checks the rules.

Review is optional, and strict when you want it#

By default an editor may publish a draft directly. Turn on Require review in Documentation → Settings (the parameter smarterp_docs.require_review) and a page must be approved first, and nobody may approve a page they wrote.

A published page also carries a review date. When it passes, a daily job marks the page Needs review and asks its owner. Reading the page and pressing Mark as Reviewed starts the next cycle, as many months long as smarterp_docs.review_months says.

Before a page can move on#

Submitting, approving and publishing need a title, a summary, a product and some content. The form says what is missing.

4. Advanced Configuration Points#

• Automated Actions & Scheduled Tasks (Crons):
  • Documentation: Auto-rebuild search index (smarterp_docs.ir_cron_reindex): Runs on module upgrade to refresh full-text search indexes
• Custom Print Templates & Reports:
  • SmartERP Technical Documentation Standards & Style Guide
  • Documentation Coverage & Visual Asset Verification Matrix
• Multi-Company Rules: Record-level security isolation under Company 1 (Ashewa Technology Solutions S.C.), preventing cross-company ledger leakage across parent and subsidiary legal entities.

5. Comprehensive Troubleshooting Matrix#