Search

13 results

1. How this site works About these docs

   Files on disk, pages in the database, and the public site served from them.

2. Writing pages About these docs

   The file layout, front matter and the Markdown you can use, with examples of each.

3. Translating About these docs

   How the English and Amharic versions relate, how to add a translation, and how to find what is missing.

4. Publish on doc.smarterp.et About these docs

   Serve the documentation from its own domain, with HTTPS, without exposing the rest of SmartERP.

5. Document your own module About these docs

   Ship documentation inside any SmartERP module so it appears on this site when the module is installed.

6. Screenshots About these docs

   Take screenshots with a script, in English and Amharic, and keep them current.

7. Organise documentation by product, module and audience About these docs

   The catalog of products, areas and modules, versions, audiences, industries and tags, and how pages use it.

8. Documentation standard About these docs

   The rules every SmartERP module's documentation follows - structure, audiences, writing style, accuracy, screenshots, diagrams and review.

9. Write in the editor and publish About these docs

   The rich-text editor, the life of a page from draft to archived, and who may do what.

10. Who can read a page About these docs

    Public, customer, partner and internal pages, and how the site and the API keep them apart.

11. Dashboard, quality checks and coverage About these docs

    What needs attention, which rules a page breaks, and which parts of a guide each product is missing.

12. Search filters and the read-only API About these docs

    Narrow search by product, module, version, audience, industry, type or tag, and read the same pages as JSON.

13. Connect courses, employees and documents About these docs

    How documentation points at eLearning courses, job positions and controlled documents without copying them.