D5: audit other markdown files (closes #103)#132
Merged
Conversation
Fixes the two drift items found by audit (README.md handled separately in #131 / closes #118 / closes #102): - docfx_project/index.md was the unfilled DocFX landing-page template — '# Title', 'Quick Start Notes:' placeholder, and a template-comment about adding images. Rewritten using the DateTime-Extensions canonical landing-page shape: real title, about paragraph, quick-links, installation, doc-section index, and additional-resources block. - docs/setup.md had the wrong test project name in three places: the actual test project is 'tests/Wolfgang.Extensions.IComparable.Tests.Unit/...' not '.../Wolfgang.Extensions.IComparable.Tests/...'. Fixed all three references. Other markdown files (CHANGELOG, CONTRIBUTING, CODE_OF_CONDUCT, SECURITY, .github/copilot-instructions.md, .github/pull_request_template.md, docs/introduction.md, docs/getting-started.md, docs/README-FORMATTING.md, docs/RELEASE-WORKFLOW-SETUP.md, docs/WORKFLOW_SECURITY.md, docs/DOCFX-VERSION-PICKER.md) were read and found accurate — no changes needed.
Contributor
There was a problem hiding this comment.
Pull request overview
Doc-only PR that audits and fixes markdown drift by replacing the DocFX landing-page stub and correcting the unit test project path references in setup docs.
Changes:
- Rewrote
docfx_project/index.mdinto a real landing page with quick links, installation snippet, and resource links. - Fixed
docs/setup.mdreferences to the unit test project path to match the actualtests/Wolfgang.Extensions.IComparable.Tests.Unitproject.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docfx_project/index.md | Replaces the placeholder DocFX landing page with a real documentation homepage and links. |
| docs/setup.md | Corrects unit test project references to the actual *.Tests.Unit project path in commands and the repo tree diagram. |
Two Copilot findings on docfx_project/index.md (L13 + L31) — both pointing at the same issue: the API Reference link was hardcoded to the GitHub Pages domain plus '/versions/latest/...', which breaks docfx build --serve previews and any hosting that isn't the canonical gh-pages URL (forks, custom domains, etc.). Replaced both with the relative path 'api/Wolfgang.Extensions.IComparable.html'. DocFX resolves it correctly in every environment (local preview, gh-pages, fork, custom domain) because the API yaml metadata lives at the same level as index.md inside docfx_project.
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
D5 audit of all markdown files except
README.md(separate D2 PR#131). Two drift items fixed.
Fixed
docfx_project/index.mdThe DocFX landing page was the unfilled template:
Rewritten using the DateTime-Extensions canonical landing-page shape
— real title, about paragraph linking to the source repo, Quick Links,
Installation block with
dotnet add package, Documentation Sectionslinking to the two docs/ subpages and the auto-generated API
reference, plus Contributing/Code-of-Conduct/License links.
docs/setup.mdThree references to the test project used the wrong name:
The actual project on disk is
Wolfgang.Extensions.IComparable.Tests.Unit. Fixed all three occurrences (thedotnet testcommand on L122, plus the source-tree diagram on L171-172).Other markdown read and found accurate
CHANGELOG.mdCONTRIBUTING.mdCODE_OF_CONDUCT.mdSECURITY.md.github/copilot-instructions.md.github/pull_request_template.mddocs/introduction.mddocs/getting-started.mddocs/README-FORMATTING.mddocs/RELEASE-WORKFLOW-SETUP.mddocs/WORKFLOW_SECURITY.mddocs/DOCFX-VERSION-PICKER.mdStacked on vNext (PR #129).