{"id":21445778,"url":"https://github.com/sensenet/sn-doc-tools","last_synced_at":"2025-03-17T01:23:18.009Z","repository":{"id":220072119,"uuid":"707694885","full_name":"SenseNet/sn-doc-tools","owner":"SenseNet","description":null,"archived":false,"fork":false,"pushed_at":"2024-09-09T01:02:37.000Z","size":95,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-01-23T11:19:53.133Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SenseNet.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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,"publiccode":null,"codemeta":null}},"created_at":"2023-10-20T13:04:18.000Z","updated_at":"2023-11-24T09:59:08.000Z","dependencies_parsed_at":"2024-02-21T03:16:39.235Z","dependency_job_id":"203c1f8c-585c-40ae-853f-93f40b30c2c3","html_url":"https://github.com/SenseNet/sn-doc-tools","commit_stats":null,"previous_names":["sensenet/sn-doc-tools"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SenseNet%2Fsn-doc-tools","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SenseNet%2Fsn-doc-tools/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SenseNet%2Fsn-doc-tools/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SenseNet%2Fsn-doc-tools/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SenseNet","download_url":"https://codeload.github.com/SenseNet/sn-doc-tools/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243955729,"owners_count":20374374,"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":[],"created_at":"2024-11-23T02:38:44.830Z","updated_at":"2025-03-17T01:23:17.990Z","avatar_url":"https://github.com/SenseNet.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# sensenet documentation tools\n\nThis repository contains tools for generating documentation for the sensenet ecosystem.\n\n## SnDocumentGenerator\n\nThis tool generates markdown files for sensenet documentation by processing source code. There are two main topics that we generate documentation for:\n\n- **OData REST API**\n- **configuration (Options classes)**. \n\nThe files are generated using the documentation code comments written in C# files. The tool processes only the XML style documentation; single line (`/// example...`) and delimited (`/* example... */`) comments are skipped.\n\nThe document generator does not use templates, the document formats are hardcoded. The generator recognizes and uses the following documetation elements and attributes: \n\n`\u003csummary\u003e \u003cremarks\u003e \u003cpara\u003e \u003cnodoc\u003e \u003cparam name=\"\"\u003e \u003cparamref name=\"\"\u003e \u003creturns\u003e \u003cvalue\u003e;text\u003c/value\u003e \u003csee cref=\"\"\u003e \u003cseealso cref=\"\"\u003e \u003cexample\u003e \u003cexception\u003e`\n\nThe tool is a console application that can be called by the following shell line:\n\n```\nSnDocumentGenerator \u003cInputDir\u003e \u003cOutputDir\u003e [-cat|-op|-flat] [-all]\n```\n### Input directory (required)\nIf the given path is a directory, the tool looks up the project and C# files under it but can process a single file too if the input path points to a file.\n\n### Output directory (required)\nDefines the root directory for generated files. If the directory does not exist, it will be created, otherwise **all its contents will be deleted** before the newly generated files are written.\n\nThe generated structure is the following under the output directory:\n```\nbackend\n  ODataOperations\n    cheatsheet.md\n    index.md\n    ... more md files\n  OptionClasses\n    cheatsheet.md\n    index.md\n    ... more md files\nfrontend\n  ODataOperations\n    cheatsheet.md\n    index.md\n    ... more md files\n  OptionClasses\n    cheatsheet.md\n    index.md\n    ... more md files\ngeneration.txt\n```\n- **backend**: documents for sensenet ecosystem developers\n- **frontend**: documents for developers or operators who use sensenet\n- **cheatsheet.md**: compressed memo/example of all generated items.\n- **index.md**: contains links to all generated items.\n\n### Output structure (optional)\nThis option controls the target structure of the REST API documentation. Every operation is categorized int the documentation comments by the `\u003csnCategory\u003e` element. There are three kinds of groups by these switches:\n\n- `-flat`: This is the default. There is no categorization, the files are written directly into the target directory.\n- `-cat`: Every category is one file that contains all operations.\n- `-op`: Every operation is a separate file but grouped in folders per category.\n\n### Detail (optional)\nThe tool differentiates the projects by the following categories:\n- Modern: .NET, .NET Standard and .NET Core projects\n- Old school: .NET Framework projects (max version 4.8.1)\n- Test projects: the project file name ends with \"tests\" or \"test\"\n\nThe default document generation processes files only in modern projects. If the `-all` switch is present, the old school and test projects are processed too.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsensenet%2Fsn-doc-tools","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsensenet%2Fsn-doc-tools","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsensenet%2Fsn-doc-tools/lists"}