{"id":15411887,"url":"https://github.com/walkercoderanger/semver-docs","last_synced_at":"2025-07-21T09:32:08.527Z","repository":{"id":147914870,"uuid":"378706282","full_name":"WalkerCodeRanger/semver-docs","owner":"WalkerCodeRanger","description":"API docs for the semver NuGet package","archived":false,"fork":false,"pushed_at":"2024-10-30T21:38:02.000Z","size":876,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-04T00:41:28.633Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"C#","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/WalkerCodeRanger.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,"publiccode":null,"codemeta":null}},"created_at":"2021-06-20T17:45:20.000Z","updated_at":"2025-02-07T18:34:27.000Z","dependencies_parsed_at":"2025-02-09T12:35:25.332Z","dependency_job_id":null,"html_url":"https://github.com/WalkerCodeRanger/semver-docs","commit_stats":{"total_commits":60,"total_committers":1,"mean_commits":60.0,"dds":0.0,"last_synced_commit":"e4684052c174a769a0f7942de958248379cb7dc6"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/WalkerCodeRanger/semver-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WalkerCodeRanger%2Fsemver-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WalkerCodeRanger%2Fsemver-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WalkerCodeRanger%2Fsemver-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WalkerCodeRanger%2Fsemver-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/WalkerCodeRanger","download_url":"https://codeload.github.com/WalkerCodeRanger/semver-docs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WalkerCodeRanger%2Fsemver-docs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266275967,"owners_count":23903960,"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-10-01T16:50:30.702Z","updated_at":"2025-07-21T09:32:08.503Z","avatar_url":"https://github.com/WalkerCodeRanger.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Semver NuGet Package Docs\r\n\r\nThis repository generates the docs for the [semver NuGetpackage](https://www.nuget.org/packages/semver/)\r\n([github.com/WalkerCodeRanger/semver](https://github.com/WalkerCodeRanger/semver)). The docs are\r\npublished via GitHub pages to [semver-nuget.org](https://semver-nuget.org).\r\n\r\n## Building\r\n\r\nThe docs are generated using [docfx](https://dotnet.github.io/docfx) via a [cake](https://cakebuild.net/)\r\nbuild script. Cake is set up in the repository directory as a dotnet tool. Use `dotnet tool restore`\r\nto download it before running the first time. A basic build can be run from the command line using:\r\n\r\n```bat\r\ndotnet cake\r\n```\r\n\r\nTo serve the docs locally, run:\r\n\r\n```bat\r\ndotnet cake --target=serve\r\n```\r\n\r\n## Project Structure\r\n\r\nThe source code of the semver project is imported via a git submodules a the `src/v?.?.?/`\r\ndirectory. Each version that docs are generated for is imported as a separate submodule. API\r\nmetadata is generated into a `v?.?.x/` directory, but is not committed. Docs are generated for all\r\nversions with the same major and minor version because patch versions should not change the public\r\nAPI. However, the latest patch version should be used to generate docs because there may be updated\r\ndoc comments. DocFx's support of generating docs for multiple versions is limited and incomplete.\r\nWhen configured to generate for multiple versions, it seems to treat them as fully independent. To\r\nwork around this, the build generates a separate site for each version into the `build` directory.\r\nThat creates docs for each version that have the proper relationship to the table of contents at the\r\nroot level. In addition, it builds a \"merged\" version to properly generate the root level pages in a\r\nway that references all versions. The build then assembles the final site from those. Any version\r\nspecific files are taken from the corresponding version build. All files outside the version\r\nspecific directories are taken from the \"merged\" version. The actual documentation site is generated\r\ninto and served from the `docs/` directory. Because GitHub pages cannot run cake or docfx, the\r\n`docs/` directory is committed and GitHub pages serves it as a completely static site. Use `dotnet\r\ncake` before committing the `docs/` directory to ensure it matches the build/project state.\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwalkercoderanger%2Fsemver-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwalkercoderanger%2Fsemver-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwalkercoderanger%2Fsemver-docs/lists"}