{"id":15060818,"url":"https://github.com/fsharp/fsharp-core-docs","last_synced_at":"2025-10-20T00:32:05.670Z","repository":{"id":40237331,"uuid":"209342067","full_name":"fsharp/fsharp-core-docs","owner":"fsharp","description":"Generated API documentation for the FSharp.Core library. Generated using FSharp.Formatting.","archived":false,"fork":false,"pushed_at":"2025-01-29T17:42:17.000Z","size":4080,"stargazers_count":34,"open_issues_count":11,"forks_count":19,"subscribers_count":10,"default_branch":"main","last_synced_at":"2025-01-30T09:41:45.031Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://fsharp.github.io/fsharp-core-docs","language":null,"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/fsharp.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-09-18T15:24:58.000Z","updated_at":"2024-06-07T07:04:48.000Z","dependencies_parsed_at":"2023-10-16T08:57:30.919Z","dependency_job_id":"8bf2ac3a-58e6-4d7f-b044-00210601c67c","html_url":"https://github.com/fsharp/fsharp-core-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fsharp%2Ffsharp-core-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fsharp%2Ffsharp-core-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fsharp%2Ffsharp-core-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fsharp%2Ffsharp-core-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fsharp","download_url":"https://codeload.github.com/fsharp/fsharp-core-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237236958,"owners_count":19277082,"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-09-24T23:04:57.625Z","updated_at":"2025-10-20T00:32:05.328Z","avatar_url":"https://github.com/fsharp.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# FSharp.Core API documentation generation\n\n\u003chttps://fsharp.github.io/fsharp-core-docs\u003e\n\n## Contributing to Library Content\n\nTo improve the content of the F# Core library documentation, contribute to the XML `///` documentation in the\nsignature files (`*.fsi`) in the FSharp.Core implementation.\n\n* Fork and clone \u003chttps://github.com/dotnet/fsharp\u003e locally, see below, as a subdirectory of your copy of `fsharp-core-docs`\n\n* Contribute to [the FSharp.Core directory](https://github.com/dotnet/fsharp/tree/main/src/fsharp/FSharp.Core)\n\n* Submit work to  `main` branch of \u003chttps://github.com/dotnet/fsharp\u003e\n\n* Update the `dotnet tool` if new versions are released.\n\n## Contributing to Generation of API Docs\n\nThe docs are generated by using `fsdocs` tool from FSharp.Formatting.  If you want to improve the generation process:\n\n* Contribute to the API Docs mode and/or HTML generator in [FSharp.Formatting.ApiDocs](https://github.com/fsprojects/FSharp.Formatting/tree/main/src/FSharp.Formatting.ApiDocs) and [the `fsdocs` tool](https://github.com/fsprojects/FSharp.Formatting/tree/main/src/FSharp.Formatting.CommandTool)\n\n* Submit work to the `main` branch of \u003chttps://github.com/fsprojects/FSharp.Formatting\u003e\n\n* Update the `dotnet tool` if new versions are released.\n\n## Build steps\n\n    dotnet tool restore\n    dotnet restore FSharp.Core\n    dotnet fsdocs build\n\nFor now, we want to pick up the latest copies of FSharp.Formatting and FSharp.Core, and set you up to make contributions to these. So we ask you to clone local copies of these:\n\n    (start in 'fsharp-core-docs')\n    dotnet restore FSharp.Core\n    dotnet tool restore\n\n    (make fsharp-compiler-docs/fsharp)\n    git clone https://github.com/dotnet/fsharp --depth 1 -b main\n\n    (build 'fsharp-core-docs/fsharp')\n    pushd fsharp\n    dotnet build src\\FSharp.Core\\FSharp.Core.fsproj /p:BUILDING_USING_DOTNET=true\n    popd\n\nThen do iterative development using:\n\n    (from 'fsharp-core-docs')\n    dotnet fsdocs watch --sourcefolder fsharp\n\n## CI Pipeline\n\nThis repo is published via GitHub Actions. On each push to main, the docs are built, and the outputs (which are written to the `output` directory by fsdocs) are pushed to the `gh-pages` branch. This repo is configured to host using GitHub Pages from this branch, so once the generated files are pushed the update is nearly-instant.\n\nTo build the very latest and freshest docs the CI does this:\n\n1. build dotnet/fsharp `main` branch (where we assume latest doc updates have been pushed).\n\n2. generate the documentation using the local dotnet fsdocs tool.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffsharp%2Ffsharp-core-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffsharp%2Ffsharp-core-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffsharp%2Ffsharp-core-docs/lists"}