Module
Documentation
This documentation platform.
Pages 13
-
How this site works
Files on disk, pages in the database, and the public site served from them.
About these docs -
Writing pages
The file layout, front matter and the Markdown you can use, with examples of each.
About these docs -
Translating
How the English and Amharic versions relate, how to add a translation, and how to find what is missing.
About these docs -
Publish on doc.smarterp.et
Serve the documentation from its own domain, with HTTPS, without exposing the rest of SmartERP.
About these docs -
Document your own module
Ship documentation inside any SmartERP module so it appears on this site when the module is installed.
About these docs -
Screenshots
Take screenshots with a script, in English and Amharic, and keep them current.
About these docs -
Organise documentation by product, module and audience
The catalog of products, areas and modules, versions, audiences, industries and tags, and how pages use it.
About these docs -
Documentation standard
The rules every SmartERP module's documentation follows - structure, audiences, writing style, accuracy, screenshots, diagrams and review.
About these docs -
Write in the editor and publish
The rich-text editor, the life of a page from draft to archived, and who may do what.
About these docs -
Who can read a page
Public, customer, partner and internal pages, and how the site and the API keep them apart.
About these docs -
Dashboard, quality checks and coverage
What needs attention, which rules a page breaks, and which parts of a guide each product is missing.
About these docs -
Search filters and the read-only API
Narrow search by product, module, version, audience, industry, type or tag, and read the same pages as JSON.
About these docs -
Connect courses, employees and documents
How documentation points at eLearning courses, job positions and controlled documents without copying them.
About these docs