{"id":14963582,"url":"https://github.com/dotnet/api-docs-sync","last_synced_at":"2025-10-19T08:32:04.057Z","repository":{"id":38215030,"uuid":"193951280","full_name":"dotnet/api-docs-sync","owner":"dotnet","description":"Tools for porting documentation from intellisense xmls to api-docs, or from api-docs to triple slash comments.","archived":false,"fork":false,"pushed_at":"2024-09-21T20:49:04.000Z","size":599,"stargazers_count":10,"open_issues_count":44,"forks_count":16,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-01-30T07:42:32.804Z","etag":null,"topics":["documentation","dotnet","ecmaxml","intellisense","roslyn"],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dotnet.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE-OF-CONDUCT.md","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":"2019-06-26T17:40:39.000Z","updated_at":"2024-09-21T20:49:07.000Z","dependencies_parsed_at":"2024-01-23T21:57:06.516Z","dependency_job_id":"6a599fc3-b419-46a5-926b-12f6711e72b9","html_url":"https://github.com/dotnet/api-docs-sync","commit_stats":{"total_commits":263,"total_committers":10,"mean_commits":26.3,"dds":0.2889733840304183,"last_synced_commit":"467397badf50362f9086f7d6d218791b80fb9ec1"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dotnet%2Fapi-docs-sync","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dotnet%2Fapi-docs-sync/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dotnet%2Fapi-docs-sync/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dotnet%2Fapi-docs-sync/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dotnet","download_url":"https://codeload.github.com/dotnet/api-docs-sync/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237092780,"owners_count":19254272,"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":["documentation","dotnet","ecmaxml","intellisense","roslyn"],"created_at":"2024-09-24T13:31:49.527Z","updated_at":"2025-10-19T08:31:58.267Z","avatar_url":"https://github.com/dotnet.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# API Docs Sync\n\nThis repo contains two tools that allow porting documentation in two directions:\n\n- IntelliSense xml files to MS Docs xml files. [Instructions](docs/PortToDocs.md).\n\n- MS Docs xml files to triple slash comments in source code. [Instructions](docs/PortToTripleSlash.md).\n\n## Requirements\n\n- [.NET 8.0 SDK](https://get.dot.net/)\n- A local git clone of a dotnet repo with source code whose APIs live in an API docs repo. Examples:\n  - [dotnet/runtime](https://github.com/dotnet/runtime)\n  - [dotnet/winforms](https://github.com/dotnet/winforms)\n  - [dotnet/wpf](https://github.com/dotnet/wpf)\n  - [dotnet/wcf](https://github.com/dotnet/wcf)\n- A local git clone of the API docs repo where the above project hosts its documentation. For example, all the repos listed above host their documentation in the [dotnet-api-docs repo](https://github.com/dotnet/dotnet-api-docs).\n\n## Install as dotnet tools\n\nTo install the two tools as global dotnet tools in your `$PATH`, run the `install-as-tool.ps1` script.\n\nDocumentation for global dotnet tools: https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-tool-install\n\nRemember to update the tool periodically to collect the latest changes. Updating instructions: https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-tool-update\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdotnet%2Fapi-docs-sync","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdotnet%2Fapi-docs-sync","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdotnet%2Fapi-docs-sync/lists"}