-
Notifications
You must be signed in to change notification settings - Fork 1k
Migrate docs site from Jekyll to DocFX #1642
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
clairernovotny
wants to merge
20
commits into
main
Choose a base branch
from
use-docfx
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 14 commits
Commits
Show all changes
20 commits
Select commit
Hold shift + click to select a range
e39088f
Migrate docs site from Jekyll to DocFX
clairernovotny b75435a
Docs: refine examples and configuration guidance across documentation
clairernovotny 9d0b15e
Docs: extract DocFX multi-version build into scripts/build-docfx.sh a…
clairernovotny 402b28b
Merge branch 'main' into use-docfx
clairernovotny ca4b984
Address code review feedback: fix documentation syntax and handle leg…
Copilot 5d312f0
Update docs/application-integration.md
clairernovotny b8fdf57
Update docs/string-transformations.md
clairernovotny 4e8df74
Fix documentation paths, error codes, and script robustness (#1644)
Copilot f05cc09
Automate API toc.yml generation in DocFX (#1645)
Copilot ff6efd6
fixes
clairernovotny 2aae79f
add docfx prerelease feed
clairernovotny 47746b8
remove old feed
clairernovotny 18cb468
Adopt Docusaurus shell with DocFX API pipeline
clairernovotny 7a4db65
add serena config
clairernovotny 37257ee
Add docs generation helper script
clairernovotny 7341a4e
Improve API docs navigation and theming
clairernovotny de24982
Enable Prism syntax highlighting for docs
clairernovotny 99505c3
Fix API page layout and hook usage
clairernovotny 3c91ddd
Enhance documentation generation and API reference structure
clairernovotny 4fab166
Refactor build commands in suggested_commands.md for clarity
clairernovotny File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| { | ||
| "version": 1, | ||
| "isRoot": true, | ||
| "tools": { | ||
| "docfx": { | ||
| "version": "2.78.4", | ||
| "commands": [ | ||
| "docfx" | ||
| ], | ||
| "rollForward": false | ||
| } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| name: Build and Deploy Docs | ||
|
|
||
| on: | ||
| push: | ||
| branches: ["main"] | ||
| workflow_dispatch: | ||
|
|
||
| permissions: | ||
| contents: read | ||
| pages: write | ||
| id-token: write | ||
|
|
||
| concurrency: | ||
| group: "pages" | ||
| cancel-in-progress: false | ||
|
|
||
| jobs: | ||
| build: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| fetch-depth: 0 | ||
|
|
||
| - name: Setup .NET SDK | ||
| uses: actions/setup-dotnet@v4 | ||
| with: | ||
| global-json-file: global.json | ||
|
|
||
| - name: Restore .NET tools | ||
| run: dotnet tool restore | ||
|
|
||
| - name: Setup Node.js | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: 20 | ||
| cache: npm | ||
| cache-dependency-path: website/package-lock.json | ||
|
|
||
| - name: Install Docusaurus dependencies | ||
| working-directory: website | ||
| run: npm ci | ||
|
|
||
| - name: Build DocFX API versions | ||
| shell: bash | ||
| run: .github/workflows/scripts/build-docfx.sh | ||
|
|
||
| - name: Build Docusaurus site | ||
| working-directory: website | ||
| run: npm run build | ||
|
|
||
| - name: Setup Pages | ||
| uses: actions/configure-pages@v5 | ||
|
|
||
| - name: Upload artifact | ||
| uses: actions/upload-pages-artifact@v3 | ||
| with: | ||
| path: website/build | ||
|
|
||
| deploy: | ||
| environment: | ||
| name: github-pages | ||
| url: ${{ steps.deployment.outputs.page_url }} | ||
| runs-on: ubuntu-latest | ||
| needs: build | ||
| steps: | ||
| - name: Deploy to GitHub Pages | ||
| id: deployment | ||
| uses: actions/deploy-pages@v4 | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,127 @@ | ||
| #!/bin/bash | ||
|
|
||
| set -euo pipefail | ||
|
|
||
| ROOT="$(pwd)" | ||
| ARTIFACT_DIR="$ROOT/.docfx-artifacts" | ||
| WORKTREE_ROOT="$ROOT/.docfx-worktrees" | ||
| STATIC_API_DIR="$ROOT/website/static/api" | ||
| WORKTREES_TO_REMOVE=() | ||
| DOCFX_CMD="dotnet tool run docfx" | ||
|
|
||
| cleanup() { | ||
| if [ ${#WORKTREES_TO_REMOVE[@]} -gt 0 ]; then | ||
| for worktree in "${WORKTREES_TO_REMOVE[@]}"; do | ||
| if [ -d "$worktree" ]; then | ||
| git worktree remove --force "$worktree" >/dev/null 2>&1 || true | ||
| fi | ||
| done | ||
| fi | ||
|
|
||
| rm -rf "$ARTIFACT_DIR" "$WORKTREE_ROOT" | ||
| } | ||
| trap cleanup EXIT | ||
|
|
||
| rm -rf "$ARTIFACT_DIR" "$WORKTREE_ROOT" | ||
| mkdir -p "$ARTIFACT_DIR" "$WORKTREE_ROOT" | ||
|
|
||
| build_docfx_for_checkout() { | ||
| local checkout_root="$1" | ||
| local destination_name="$2" | ||
|
|
||
| pushd "$checkout_root" >/dev/null | ||
| $DOCFX_CMD metadata docs/docfx.json | ||
| $DOCFX_CMD build docs/docfx.json | ||
| popd >/dev/null | ||
|
|
||
| mkdir -p "$ARTIFACT_DIR/$destination_name" | ||
| cp -a "$checkout_root/docs/_site/." "$ARTIFACT_DIR/$destination_name/" | ||
| } | ||
|
|
||
| # Build current checkout (development) | ||
| build_docfx_for_checkout "$ROOT" "main" | ||
| rm -rf "$ROOT/docs/_site" | ||
|
|
||
| # Discover release branches | ||
| RELEASE_VERSIONS=() | ||
| SKIP_FETCH="${SKIP_RELEASE_FETCH:-0}" | ||
|
|
||
| if [ "$SKIP_FETCH" != "1" ]; then | ||
| RELEASE_TMP="$(mktemp)" | ||
| if git ls-remote --heads origin 'rel/v*' >"$RELEASE_TMP"; then | ||
| if [ -s "$RELEASE_TMP" ]; then | ||
| git fetch --no-tags origin 'refs/heads/rel/*:refs/remotes/origin/rel/*' | ||
| mapfile -t RELEASE_VERSIONS < <(git for-each-ref --format='%(refname:short)' refs/remotes/origin/rel | sed 's#^origin/rel/##' | sort -rV) | ||
| fi | ||
| else | ||
| echo "Warning: unable to query release branches; continuing with development API only." | ||
| fi | ||
| rm -f "$RELEASE_TMP" | ||
| else | ||
| echo "Skipping release branch builds per SKIP_RELEASE_FETCH=$SKIP_FETCH" | ||
| fi | ||
|
|
||
| LATEST_RELEASE="" | ||
| BUILT_RELEASES=() | ||
|
|
||
| for version in "${RELEASE_VERSIONS[@]}"; do | ||
| [ -n "$version" ] || continue | ||
|
|
||
| branch="origin/rel/$version" | ||
| worktree="$WORKTREE_ROOT/$version" | ||
| git worktree add --force "$worktree" "$branch" | ||
| WORKTREES_TO_REMOVE+=("$worktree") | ||
|
|
||
| if [ ! -f "$worktree/docs/docfx.json" ]; then | ||
| echo "Skipping $version: no DocFX configuration found" | ||
| git worktree remove --force "$worktree" | ||
| unset 'WORKTREES_TO_REMOVE[-1]' | ||
| continue | ||
| fi | ||
|
|
||
| if build_docfx_for_checkout "$worktree" "$version"; then | ||
| BUILT_RELEASES+=("$version") | ||
| if [ -z "$LATEST_RELEASE" ]; then | ||
| LATEST_RELEASE="$version" | ||
| fi | ||
| else | ||
| echo "Failed to build documentation for $version, skipping" | ||
| fi | ||
|
|
||
| git worktree remove --force "$worktree" || true | ||
| unset 'WORKTREES_TO_REMOVE[-1]' | ||
| done | ||
|
clairernovotny marked this conversation as resolved.
|
||
|
|
||
| rm -rf "$STATIC_API_DIR" | ||
| mkdir -p "$STATIC_API_DIR" | ||
|
|
||
| cp -a "$ARTIFACT_DIR/main/." "$STATIC_API_DIR/main/" | ||
|
|
||
| for version in "${BUILT_RELEASES[@]}"; do | ||
| mkdir -p "$STATIC_API_DIR/$version" | ||
| cp -a "$ARTIFACT_DIR/$version/." "$STATIC_API_DIR/$version/" | ||
| done | ||
|
|
||
| if [ -n "$LATEST_RELEASE" ]; then | ||
| DEFAULT_RELEASE="$LATEST_RELEASE" | ||
| else | ||
| DEFAULT_RELEASE="main" | ||
| fi | ||
|
|
||
| if [ "${#BUILT_RELEASES[@]}" -gt 0 ]; then | ||
| releases_json="[" | ||
| for version in "${BUILT_RELEASES[@]}"; do | ||
| releases_json+="\"$version\","; | ||
| done | ||
| releases_json="${releases_json%,}]" | ||
| else | ||
| releases_json="[]" | ||
| fi | ||
|
|
||
| cat >"$STATIC_API_DIR/versions.json" <<MANIFEST | ||
| { | ||
| "latest": "$DEFAULT_RELEASE", | ||
| "releases": $releases_json, | ||
| "development": "main" | ||
| } | ||
| MANIFEST | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| /cache |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| - Use `.editorconfig` defaults: spaces, 4-space indentation, file-scoped namespaces, trim redundant blank lines. | ||
| - Prefer language keywords (`string`, `int`) and `var` when the type is obvious. Avoid unnecessary `this.` qualifiers. | ||
| - Order `using` statements with `System.*` first; rely on existing global usings. | ||
| - Keep code self-documenting; comments are rare and reserved for non-obvious logic. Never wrap imports in `try/catch`. | ||
| - Follow Humanizer naming conventions (camelCase private fields, PascalCase public members/static readonly/constants). | ||
| - Skip braces for single-line statements when consistent with surrounding code. | ||
| - Add XML documentation for any new or modified public APIs and update README/docs when behavior changes. | ||
| - Tests: organize with xUnit, group by feature/culture, use `UseCulture` attribute for localization-specific assertions. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| - **Purpose:** Humanizer is a .NET library that converts numbers, dates, times, enums, quantities, strings, and collections into human-friendly text across 40+ locales. Primary code lives in `src/Humanizer`; validation happens in `src/Humanizer.Tests`. | ||
| - **Tech stack:** C# targeting .NET 10.0/9.0/8.0 and .NET Framework 4.8 (plus .NET Standard 2.0 for analyzers). Uses xUnit for tests, DocFX for docs, Azure DevOps for CI, and optional analyzers under `src/Humanizer.Analyzers`. | ||
| - **Repo layout:** | ||
| - `src/Humanizer` – main library, resources, configuration. | ||
| - `src/Humanizer.Tests` – xUnit suites organized by feature/culture (uses `UseCulture`). | ||
| - `src/Humanizer.Analyzers` + `.Tests` – Roslyn analyzers and coverage. | ||
| - `src/Benchmarks` – perf harness. | ||
| - `docs`/`docfx3` – documentation site built with DocFX. | ||
| - `NuSpecs`, `version.json`, `verify-packages.ps1` – packaging/release assets. | ||
| - **Key guidelines:** Follow `.editorconfig`, modern C#, file-scoped namespaces, `var` for obvious types, System usings first, minimal comments, no `try/catch` around imports, XML docs for public APIs, update README/docs when behavior changes. | ||
| - **Localization:** Cultures live under `src/Humanizer/Properties`; register new formatters in registry classes and add localized tests under `src/Humanizer.Tests/Localisation/<culture>`. | ||
| - **Docs & samples:** Build via `dotnet tool run docfx` commands in README; samples under `samples/Humanizer.MvcSample` (legacy MVC example). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| ```bash | ||
| # Inspect repo status / files (Linux environment) | ||
| git status | ||
| ls -a | ||
| rg "search term" | ||
|
|
||
| # Restore + build | ||
| cd /home/claire/local-dev/Humanizer/src | ||
| DOTNET_CLI_UI_LANGUAGE=en dotnet restore | ||
| DOTNET_CLI_UI_LANGUAGE=en dotnet build Humanizer/Humanizer.csproj -c Release /t:PackNuSpecs /p:PackageOutputPath=<out> | ||
|
|
||
| # Run tests (Linux skips net48) | ||
| dotnet test src/Humanizer.Tests/Humanizer.Tests.csproj --framework net10.0 | ||
| dotnet test src/Humanizer.Tests/Humanizer.Tests.csproj --framework net8.0 | ||
|
|
||
| # Verify packages after building | ||
| pwsh ./verify-packages.ps1 -PackagesPath <out> -MinimumPassingSdkVersion 9.0.200 | ||
|
|
||
| # DocFX docs (from repo root) | ||
| dotnet tool restore | ||
| dotnet tool run docfx build docs/docfx.json | ||
| # Preview docs | ||
| dotnet tool run docfx serve docs/_site | ||
|
|
||
| # Benchmarks (example) | ||
| dotnet run --project src/Benchmarks/Benchmarks.csproj -c Release | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| - Ensure dotnet test passes for net10.0 and net8.0 (`src/Humanizer.Tests/Humanizer.Tests.csproj`). Avoid running net48 on Linux. | ||
| - When applicable, run `dotnet build Humanizer/Humanizer.csproj -c Release /t:PackNuSpecs` (from `src`) to confirm packaging stays healthy. | ||
| - Update or add xUnit tests alongside code changes, including culture-specific suites. | ||
| - Refresh docs/README or XML summaries when altering behavior, locales, or APIs. Regenerate DocFX content if needed (`dotnet tool run docfx build docs/docfx.json`). | ||
| - For localization additions, duplicate resource files, register formatters, and add tests in `src/Humanizer.Tests/Localisation/<culture>`. | ||
| - After packaging, optionally run `verify-packages.ps1` with the package output path and minimum SDK (default 9.0.200). | ||
| - Confirm `git status` shows only intended changes before handing off or creating a PR. |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.