Fix DocFX configuration and add documentation content#73
Merged
Conversation
The docs site was blank because docfx_project/ still contained repo-template placeholders. Replace all placeholders with real values and write actual documentation content. - docfx.json: fix project path, app name, title, base URL, templates - Add root toc.yml linking Documentation and API Reference sections - Add logo.svg (branded W mark) - Write landing page (index.md) with quick links and install snippet - Write introduction.md covering Try, Result, Result<T>, and composition - Write getting-started.md with installation and usage examples - Fix docs/toc.yml: correct project URL (was DbContextBuilder) - Add api/index.md for API reference landing page - Add .gitignore for api/ (generated yml) and _site/ (build output) Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the DocFX documentation project to produce a non-blank GitHub Pages site for the Try-Pattern library, replacing template placeholders and adding real documentation content plus supporting assets/config.
Changes:
- Fix DocFX metadata/build configuration (project globbing, templates, site metadata/assets).
- Add documentation content (landing page, introduction, getting started, API landing page) and TOCs.
- Add supporting assets and gitignores for generated API/build outputs.
Reviewed changes
Copilot reviewed 10 out of 11 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| docfx_project/docfx.json | Updates DocFX metadata/build config, templates, and site metadata. |
| docfx_project/index.md | Replaces placeholder landing page with real project overview and links. |
| docfx_project/toc.yml | Adds top-level DocFX TOC linking docs + API sections. |
| docfx_project/docs/toc.yml | Fixes docs section TOC casing and project website URL. |
| docfx_project/docs/index.md | Adds docs section landing page. |
| docfx_project/docs/introduction.md | Adds intro content and examples for core types. |
| docfx_project/docs/getting-started.md | Adds install/usage guide and examples. |
| docfx_project/api/index.md | Adds API section landing page. |
| docfx_project/api/.gitignore | Ignores generated API metadata YAML files. |
| docfx_project/_site/.gitignore | Ignores generated DocFX build output. |
| docfx_project/logo.svg | Adds a logo asset for site branding. |
- Remove _baseUrl from docfx.json (conflicts with versioned deployment under /versions/<tag>/) - Change API links from .yml to api/index.md (yml files aren't served) - Update prerequisites to .NET 10 SDK (repo multi-targets net10.0) Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2 tasks
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
docfx_project/with real valuesdocfx.jsonproject path (src/<path>/<project>.csproj→src/**/*.csproj), app metadata, and template configdocs/toc.ymlproject website URL (was pointing to DbContextBuilder)logo.svg, roottoc.yml,api/index.md, and.gitignorefiles for generated outputVerified
docfx metadata+docfx buildpass with 0 warnings, 0 errorsTry,Result,Result<T>Test plan
🤖 Generated with Claude Code