Write in the editor and publish
The rich-text editor, the life of a page from draft to archived, and who may do what.
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.
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 Interface#
- Log into your SmartERP instance at
https://smarterp.et/odoo. - Open the main App Switcher (grid icon in the top-left corner).
- Navigate to Settings → Technical.
Step 2: Operational Data Parameters & Controls#
Ensure all mandatory parameters comply with enterprise operational standards:
- Authorized Operator: Action executed under assigned RBAC permissions (System Administrator, Certified Specialist).
- Relational Integrity: Linked to upstream master records, approval requests, or transactional ledgers.
- Statutory & Quality Controls: Verified against Ethiopian statutory regulations and corporate governance standards.
Step 3: Operational Execution & State Progression#
- State Progression Gate: Advance record from Draft through Audited to Confirmed / Certified.
- Integrated System Impact: Automatically updates real-time operational states and posts financial/inventory journal moves.
- Audit Verification: System registers tamper-evident audit records logging user ID, timestamp, and cryptographic transaction digests.
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.
Tip
Start headings at the second level. The page title is printed above the text, and the second-level headings make the "On this page" list.
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
| State | Meaning | Visible on the site |
|---|---|---|
| Draft | Being written. | no |
| In review | Waiting for a reviewer. | no |
| Approved | Reviewed, ready to publish. | no |
| Published | Live. | yes |
| Needs review | Live, but its review date has passed. | yes |
| Deprecated | Live, with a warning and a link to its replacement. | yes |
| Archived | Retired. | no |
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#
| Role | May |
|---|---|
| Author | Create pages and edit their own drafts and pages in review. Submit for review. |
| Reviewer | Read everything. Approve, or send back with a note. |
| Editor | Everything above, and publish, unpublish, deprecate, archive and change settings. |
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#
| Error Symptom / Exception | Probable Root Cause | Corrective Action / Resolution |
|---|---|---|
Test Error: Broken link in documentation | Internal doc link refers to non-existent section or page slug. | Update link path to match valid section and page identifiers. |
Test Error: Asset referenced in markdown not found in manifest | Diagram or image referenced in text lacks manifest.json entry. | Register asset ID and file paths in static/img/manifest.json. |
Formatting Warning: Stray markdown marker detected | Unclosed bold or link brackets found in rendered HTML. | Ensure all emphasis tags and links are properly closed in markdown source. |