{"id":18810344,"url":"https://github.com/AbsaOSS/living-doc-generator-mdoc","last_synced_at":"2025-09-02T15:31:03.278Z","repository":{"id":238988412,"uuid":"798129781","full_name":"AbsaOSS/living-doc-generator","owner":"AbsaOSS","description":"\"living-doc-generator: A GitHub Action designed to data-mine GitHub repositories for issues containing project documentation (e.g., tagged with feature-related labels). This action automatically generates fresh documentation in markdown format, providing detailed feature overview pages and in-depth feature descriptions.","archived":false,"fork":false,"pushed_at":"2024-12-04T21:01:34.000Z","size":2727,"stargazers_count":2,"open_issues_count":14,"forks_count":0,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-12-07T16:25:49.009Z","etag":null,"topics":["actions","auto-docs","auto-documentation","developer-tool","documentation-generator","feature-documentation","github-action","issue-tracking","markdown-generator","open-source","project-management","repository-management"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AbsaOSS.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-05-09T06:40:02.000Z","updated_at":"2024-11-19T13:58:39.000Z","dependencies_parsed_at":"2024-06-05T08:39:02.738Z","dependency_job_id":"0562f610-6c56-4b11-a4e8-39523cfcbcfc","html_url":"https://github.com/AbsaOSS/living-doc-generator","commit_stats":null,"previous_names":["absaoss/living-doc-generator","absaoss/living_doc_generator"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AbsaOSS%2Fliving-doc-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AbsaOSS%2Fliving-doc-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AbsaOSS%2Fliving-doc-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AbsaOSS%2Fliving-doc-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AbsaOSS","download_url":"https://codeload.github.com/AbsaOSS/living-doc-generator/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":231797609,"owners_count":18428057,"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":["actions","auto-docs","auto-documentation","developer-tool","documentation-generator","feature-documentation","github-action","issue-tracking","markdown-generator","open-source","project-management","repository-management"],"created_at":"2024-11-07T23:19:51.715Z","updated_at":"2025-09-02T15:31:03.271Z","avatar_url":"https://github.com/AbsaOSS.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Living Documentation Generator\n\n- [Motivation](#motivation)\n- [Usage](#usage)\n    - [Prerequisites](#prerequisites)\n    - [Adding the Action to Your Workflow](#adding-the-action-to-your-workflow)\n- [Action Configuration](#action-configuration)\n    - [Environment Variables](#environment-variables)\n    - [Inputs](#inputs)\n- [Action Outputs](#action-outputs)\n- [Features](#features)\n    - [Report Page](#report-page)\n- [Contribution Guidelines](#contribution-guidelines)\n  - [License Information](#license-information)\n  - [Contact or Support Information](#contact-or-support-information)\n\n## Motivation\n\nThis action addresses the need for continuously updated documentation accessible to all team members and stakeholders. It achieves this by transforming raw data into an MDoc viewer-capable formatted output.\nThe raw data can be obtained from the action [liv-doc-collector-gh](https://github.com/AbsaOSS/living-doc-collector-gh) or a similar source.\n\n---\n## Usage\n\n### Prerequisites\n\nBefore we begin, ensure you have the following prerequisites:\n- Python version 3.12 or higher.\n\n### Adding the Action to Your Workflow\n\nSee the default action step definition:\n\n```yaml\n- name: Generate Living Documentation MDOC\n  id: living_doc-generator-mdoc\n  uses: AbsaOSS/living-doc-generator-mdoc@v0.1.0\n  with:\n    source: \"path/to/raw_input.json\"        # Path to the raw input file containing the data to be processed.\n\n    report-page: true                       # Optional: enable report page generation.\n    verbose-logging: true                   # Optional: project verbose (debug) logging feature de/activation\n```\n\n---\n## Action Configuration\n\nThis section outlines the essential parameters that a user can define.\n\n| Input Name          | Description                                              | Required | Default | Usage                     | \n|---------------------|----------------------------------------------------------|----------|---------|---------------------------|\n| `source`            | Path to the source file containing the data to be processed. | Yes      | N/A     | Specify the path to the raw input file. |\n| `release`           | Enables or disables release filtering.                   | No       | `false` | Set to true to activate.  |\n| `structured-output` | Enables or disables structured output generation. | No       | `false` | Set to true to activate.  |\n| `report-page`       | Enables or disables the generation of [report pages](#report-page). | No       | `false` | Set to true to activate.  |\n| `verbose-logging`   | Enables or disables verbose (debug) logging.             | No       | `false` | Set to true to activate.  |\n\n---\n## Action Outputs\n\nThe Living Documentation Generator MDOC action provides a main output path allowing users to locate and access the generated documentation easily. \nThis output can be utilized in various ways within your CI/CD pipeline to ensure the documentation is effectively distributed and accessible.\n\n- `output-path`\n  - **Description**: The root output path to the directory where all generated living documentation files are stored.\n  - **Usage**: \n   ``` yaml\n    - name: Generate Living Documentation\n      id: generate_mdoc\n      ... rest of the action definition ...\n      \n    - name: Output Documentation Path\n      run: echo \"Generated documentation path: ${{ steps.generate_mdoc.outputs.output-path }}\"            \n    ```\n\n---\n## Features\n\n### Report Page\n\nThe report page summarizes the errors found during the generation of living documents.\n\n- **Activation**: Set the `report-page` input to true to activate this feature.\n- **Non-Activated Behavior**: By default, when the feature is inactive, the errors are not listed in the output but are present in the log output.\n- **Activated Example**: The report page is generated only when some errors are found during the generation of living documents.\n  - `report-page: true` activates the generation of report page.\n    ```markdown\n    \u003ch3\u003eReport page\u003c/h3\u003e\n    \n    This page summarizes the errors found during the generation of living documents.\n    \n    \u003ch4\u003eLiving Documentation Regime\u003c/h4\u003e\n    \n    | Error Type     | Issue                                     | Message                                  |\n    | -------------- | ----------------------------------------- | ---------------------------------------- |\n    | LabelError     | organization/example-project#19           | More than one Documentation label found. |\n    ```\n\n---\n## Developer Guide\n\nSee this [Developer Guide](DEVELOPER.md) for more technical development-related information.\n\n---\n## Contribution Guidelines\n\nWe welcome contributions to the Living Documentation Generator, whether you're fixing bugs, improving documentation, or proposing new features.\n\n#### How to Contribute\n\nBefore contributing, please review our [contribution guidelines](https://github.com/AbsaOSS/living-doc-generator/blob/master/CONTRIBUTING.md) for more detailed information.\n\n### License Information\n\nThis project is licensed under the Apache License 2.0. This liberal license allows you great freedom in using, modifying, and distributing this software while also providing an express grant of patent rights from contributors to users.\n\nFor more details, see the [LICENSE](https://github.com/AbsaOSS/living-doc-generator/blob/master/LICENSE) file in the repository.\n\n### Contact or Support Information\n\nIf you need help with using or contributing to Living Documentation Generator Action, or if you have any questions or feedback, don't hesitate to reach out:\n\n- **Issue Tracker**: For technical issues or feature requests, use the [GitHub Issues page](https://github.com/AbsaOSS/living-doc-generator/issues).\n- **Discussion Forum**: For general questions and discussions, join our [GitHub Discussions forum](https://github.com/AbsaOSS/living-doc-generator/discussions).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAbsaOSS%2Fliving-doc-generator-mdoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FAbsaOSS%2Fliving-doc-generator-mdoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAbsaOSS%2Fliving-doc-generator-mdoc/lists"}