Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,15 @@ on:
paths:
- 'docs/**'
- 'docfx.json'
- 'templates/**'
- '.config/dotnet-tools.json'
- 'src/IOViewer/**'
- '.github/workflows/docs.yml'
pull_request:
paths:
- 'docs/**'
- 'docfx.json'
- 'templates/**'
- '.config/dotnet-tools.json'
- 'src/IOViewer/**'
- '.github/workflows/docs.yml'
Expand Down
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ API between minor releases.
- The release workflow runs only for version tags again, fails on any `gh release` error and no longer overwrites assets of an existing release.
- `tools/pack-release.ps1` fails when creating the source archive fails.
- Documentation no longer claims `.mtl` material support or mesh simplification, neither of which exists.
- The logo on the documentation site no longer covers half of the page; it is sized to the navigation bar.

### Added
- Links to the DeepWiki overview of the repository in the README and on the documentation site.

### Changed
- Tests run on both .NET 8 and .NET 10.
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ See the [public API](docs/public-api.md) for the supported surface and [getting

## Documentation

The documentation site with API references and guides is at <https://ioextend.github.io/IOViewer/>.
The documentation site with API references and guides is at <https://ioextend.github.io/IOViewer/>. [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/IOExtend/IOViewer) offers an automatically generated overview of the repository.

## Limitations

Expand Down
2 changes: 1 addition & 1 deletion docfx.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,6 @@
"_appFaviconPath": "images/favicon.ico",
"_enableSearch": true
},
"template": ["default", "modern"]
"template": ["default", "modern", "templates/ioviewer"]
}
}
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,6 @@ The generated HTML file is completely self-contained, offline-ready, and works i

- [Getting started](getting-started.md): install the package or CLI tool and generate your first 3D viewer.
- [Public API](public-api.md): supported surface and key entry points of the library.
- [Source on GitHub](https://github.com/IOExtend/IOViewer).
- [Source on GitHub](https://github.com/IOExtend/IOViewer) and [DeepWiki](https://deepwiki.com/IOExtend/IOViewer) for an automatically generated overview of the repository.

IOViewer is not affiliated with, endorsed by or sponsored by Autodesk. Autodesk, Revit, Navisworks, ViewCube and TimeLiner are trademarks of Autodesk, Inc.
2 changes: 2 additions & 0 deletions docs/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,5 @@
href: api/
- name: GitHub
href: https://github.com/IOExtend/IOViewer
- name: DeepWiki
href: https://deepwiki.com/IOExtend/IOViewer
5 changes: 5 additions & 0 deletions templates/ioviewer/public/main.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
/* The logo SVG is a wide wordmark; without a size it renders at its full 926x214 px in the navbar. */
#logo {
height: 2rem;
width: auto;
}
Loading