Repository navigation
docs: adopt the shared Invex documentation format - #29
Merged
Merged
Conversation
Canonical docfx.json, root toc.yml, API filter and logo theme shared across the Invex libraries. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Jy23TCq1bZkdPV2GRWfspU
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Jy23TCq1bZkdPV2GRWfspU
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Jy23TCq1bZkdPV2GRWfspU
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Jy23TCq1bZkdPV2GRWfspU
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Jy23TCq1bZkdPV2GRWfspU
Contributor
There was a problem hiding this comment.
🔵 Needs a closer look
The repository’s Copilot guidance still references the removed api/SemVer.md path.
0 open findings
What changed in this PR
Adopts the shared Invex DocFX structure and improves documentation accuracy and navigation.
Changes:
- Adds a real landing page, reorganized navigation, xrefs, and versioning documentation.
- Refreshes the README with badges, examples, and absolute links.
- Adds API filtering, logo styling, and an invocation-log security warning.
| File | Description |
|---|---|
toc.yml |
Sets the documentation homepage. |
README.md |
Reorganizes package guidance and links. |
index.md |
Replaces the redirect with a landing page. |
docs/versioning.md |
Relocates and expands versioning guidance. |
docs/transforming-output.md |
Clarifies invocation-log secret exposure. |
docs/toc.yml |
Groups guides and adds versioning. |
docs/testing.md |
Adds related links and API xrefs. |
docs/running-processes.md |
Adds related documentation links. |
docs/logging.md |
Adds related links and API xrefs. |
docs/introduction.md |
Adds use cases, limitations, and navigation. |
docs/handling-failures.md |
Adds an introduction and related links. |
docs/getting-started.md |
Improves orientation and next steps. |
docs/filterConfig.yml |
Restricts generated APIs to public Invex types. |
docs/cancellation.md |
Clarifies wait cancellation behavior. |
docfx.json |
Adopts shared DocFX metadata and theming. |
docfx-theme/public/main.css |
Sizes and aligns the site logo. |
api/index.md |
Replaces generated-file links with xrefs. |
🧠 Review effort: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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.
Requested by Dec · project thread
Before: the versioning policy sat in
api/SemVer.md, a name copied from semantic-version.api/index.mdlinked to generated.ymlfiles, the site home was a JavaScript redirect, and the README had no badges.After: the repo follows the shared Invex documentation standard.
docs/versioning.md.api/index.mduses xref links and has a Kind column.transforming-output.mdnow has a warning that points at Logging.How: the shared
docfx.json, roottoc.yml,docs/filterConfig.ymland logo theme, followed by content commits. No .NET SDK was available while writing this, so DocFX was not run locally.🤖 Generated with Claude Code
https://claude.ai/code/session_01Jy23TCq1bZkdPV2GRWfspU
Generated by Claude Code