Skip to content

Commit 874759c

Browse files
committed
Polish docs integration and repository hygiene
1 parent 4074f75 commit 874759c

File tree

5 files changed

+33
-0
lines changed

5 files changed

+33
-0
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -289,3 +289,6 @@ tools/**
289289

290290
# macOS
291291
.DS_Store
292+
293+
# Documentation output
294+
/site/.lunet/build/

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,9 @@ You can install the package for `Avalonia` based projects like this:
3333
## Resources
3434

3535
* [GitHub source code repository.](https://github.com/wieslawsoltes/PanAndZoom)
36+
* [Documentation site.](https://wieslawsoltes.github.io/PanAndZoom)
37+
* [Articles home.](site/articles/readme.md)
38+
* [Headless testing docs.](site/articles/headless-testing/readme.md)
3639

3740
## Using PanAndZoom
3841

@@ -699,6 +702,33 @@ zoomBorder.ImportState(restoredState);
699702
- Implement undo/redo functionality
700703
- Session state management
701704

705+
## Documentation
706+
707+
The repository now includes a Lunet-based documentation site, modeled after the TreeDataGrid docs pipeline and tailored to `PanAndZoom` and `HeadlessTestingFramework`.
708+
709+
Key entry points:
710+
711+
- [Docs home](site/readme.md)
712+
- [Getting Started](site/articles/getting-started/readme.md)
713+
- [Headless Testing](site/articles/headless-testing/readme.md)
714+
- [Reference](site/articles/reference/readme.md)
715+
716+
Build docs locally:
717+
718+
```bash
719+
./build-docs.sh
720+
./serve-docs.sh
721+
```
722+
723+
PowerShell:
724+
725+
```powershell
726+
./build-docs.ps1
727+
./serve-docs.ps1
728+
```
729+
730+
Generated output is written to `site/.lunet/build/www`.
731+
702732
## License
703733

704734
PanAndZoom is licensed under the [MIT license](LICENSE.TXT).

site/.lunet/layouts/_default.api-dotnet-member.sbn-md

100755100644
File mode changed.

site/.lunet/layouts/_default.api-dotnet-namespace.sbn-md

100755100644
File mode changed.

site/.lunet/layouts/_default.api-dotnet.sbn-md

100755100644
File mode changed.

0 commit comments

Comments
 (0)