{"id":22914183,"url":"https://github.com/suse/doc-modular","last_synced_at":"2026-01-11T01:11:18.218Z","repository":{"id":40387193,"uuid":"383429129","full_name":"SUSE/doc-modular","owner":"SUSE","description":null,"archived":false,"fork":false,"pushed_at":"2025-03-26T18:40:13.000Z","size":48548,"stargazers_count":11,"open_issues_count":20,"forks_count":16,"subscribers_count":11,"default_branch":"main","last_synced_at":"2025-03-26T18:54:36.091Z","etag":null,"topics":["docs","documentation","modular","suse","suse-documentation","topics"],"latest_commit_sha":null,"homepage":"https://documentation.suse.com/smart/","language":null,"has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SUSE.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2021-07-06T10:28:05.000Z","updated_at":"2025-03-26T18:40:16.000Z","dependencies_parsed_at":"2023-10-02T10:59:07.070Z","dependency_job_id":"4b7ea4dd-1bfb-44c0-aec5-1665559790ec","html_url":"https://github.com/SUSE/doc-modular","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SUSE%2Fdoc-modular","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SUSE%2Fdoc-modular/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SUSE%2Fdoc-modular/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SUSE%2Fdoc-modular/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SUSE","download_url":"https://codeload.github.com/SUSE/doc-modular/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246635945,"owners_count":20809330,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docs","documentation","modular","suse","suse-documentation","topics"],"created_at":"2024-12-14T05:13:50.382Z","updated_at":"2026-01-11T01:11:18.211Z","avatar_url":"https://github.com/SUSE.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"Modular Documentation\n=====================\n\nThis is the source of the official SUSE modular documentation. The repository currently covers the documentation for the SLE 16 product family, SUSE Linux Micro and SUSE AI.\n\n# What is this about?\n\nFor the above SUSE products we provide modular documentation, using topic-based authoring. This approach allows us to reuse pieces of information across articles (and across different product variants) without duplicating source content.\n\n# Goal\n\nOur goal is to write task-based documentation that helps readers find a solution to their problem quickly. For this purpose, the documentation is split into a set of articles (so called 'Smart Docs').   \n\n# Smart Doc articles\n\nEach article stands for itself. It minimally includes the following:\n\n* requirements\n* context\n* instructions\n* examples\n* troubleshooting\n* FAQs\n\nTechnically, Smart Doc articles are built from individual topics, like \"building blocks\". Each topic is an information unit that is\n\n* self-contained,\n* serves one distinct purpose (see the four topic types provided),\n* can be reused in multiple articles.\n\n# Topic types\n\nAccording to their purpose, we dinstinguish between four topic types:\n   * Task: *instructs* (how to?)' - [XML template](https://github.com/SUSE/doc-modular/blob/main/templates/tasks/task.xml)\n   * Concept: *explains* (what is?) - [XML template](https://github.com/SUSE/doc-modular/blob/main/templates/concepts/concept.xml)\n   * Reference: *informs* (e.g. list of options, table with config files, default settings) - [XML template](https://github.com/SUSE/doc-modular/blob/main/templates/references/reference.xml)\n   * Glue: helps *navigate* (combines texts or structures that do not fit into any of the other categories): Typical glue topics are the \"For more information\" and the \"What's next\" sections. - [XML template](https://github.com/SUSE/doc-modular/blob/main/templates/glues/glue.xml)\n\nArticles are built by bundling these topics into assembly files - organizational units that structure the topics. The assemblies are used to build coherent and meaningful documents [XML template](https://github.com/SUSE/doc-modular/blob/main/templates/articles/assembly.xml).\n\n# Tools\n\nTo build documents and validate assemblies, DAPS version 4.X Beta 11 and geekodoc are needed. To install the requried tools, proceed as follows:\n\n1. Add the documentation zypper repository:\n\n    `sudo zypper ar https://download.opensuse.org/repositories/Documentation:/Tools/ Documentaton:Tools`\n\n2. Refresh your repositories:\n\n    `sudo zypper ref`\n\n2. Install daps and geekodoc:\n\n    `sudo zypper in daps geekodoc`\n\n\n# Conventions\n\nFor a comprehensive list of conventions for modular docs, turn to the [templates README](https://github.com/SUSE/doc-modular/blob/main/templates/README.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsuse%2Fdoc-modular","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsuse%2Fdoc-modular","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsuse%2Fdoc-modular/lists"}