Skip to content

Feat: Move away from docfx to docusaurus #208

Merged
AnnaSasDev merged 12 commits intocorefrom
docusaurus
Apr 10, 2026
Merged

Feat: Move away from docfx to docusaurus #208
AnnaSasDev merged 12 commits intocorefrom
docusaurus

Conversation

@AnnaSasDev
Copy link
Copy Markdown
Member

Summary

Type of Change

  • Bug fix (non-breaking change fixing an issue)
  • New feature (non-breaking change adding functionality)
  • Breaking change (fix or feature impacting existing APIs)
  • Refactor / Code cleanup (no functional change)
  • Documentation update
  • Test addition or update
  • Other (please describe):

Affected Modules / Scope

  • InfiniFrame
  • InfiniFrame.Blazor
  • InfiniFrame.BlazorWebView
  • InfiniFrame.Js
  • InfiniFrame.Native
  • InfiniFrame.Shared
  • InfiniFrame.WebServer
  • InfiniFrame.Tools.Pack
  • InfiniFrameExample
  • InfiniFrameTests
  • Other:

Changes Introduced

Related Issues

Closes #205

Checklist

  • My code follows InfiniFrame's coding conventions
  • I added comments for complex or non-obvious code
  • Documentation updated (if applicable)
  • All tests pass locally
  • Added new tests for any new functionality
  • Existing tests pass
  • No new warnings or errors introduced
  • PR only includes changes relevant to the issue / feature

📖 Additional Context

…tation

- Add `.gitignore` rules for `docs/` to exclude build artifacts and dependencies.
- Introduce API reference in `docs/content/api.md` outlining split strategy for conceptual and generated API resources.
- Add Blazor WebView integration guide with project setup, lifecycle, and advanced configurations in `docs/content/guides/blazor-webview.md`.
- Detail coding conventions for C/C++ and C# in `docs/content/cpp/code-style.md` and `docs/content/csharp/code-style.md`.
- Provide a migration guide for breaking Photino to InfiniFrame changes in `docs/content/concepts/breaking-changes-from-photino.md`.
- Add core window builder and runtime API usage guide in `docs/content/guides/core-window.md`.
- Deleted obsolete documentation for Blazor WebView, core window API, C/C++ code style, and C# coding conventions.
- Removed migration guide detailing breaking changes from Photino.NET.
- Streamlined documentation structure by eliminating redundant and legacy content.
Move the Breaking Changes doc from /concepts to /migration: update README and docs/intro links, adjust docusaurus.config.ts redirects to forward old /concepts paths to /migration, and update sidebars accordingly. Also refresh docs package.json and package-lock.json to update Docusaurus/DocSearch-related dependencies.
- Introduced PowerShell scripts to prepare API pages (`prepare-local-api.ps1` and `update-cpp-api.ps1`).
- Added Doxygen-based C++ API reference (`native-cpp-reference.md`) pipeline.
- Integrated DocFX for local C# API reference placeholders.
- Updated `.gitignore` to exclude static/generated API artifacts.
- Adjusted `package.json` to execute API preparation in `docs:dev`.
- Applied dependency updates and configuration tweaks in docs tooling.
- Eliminated all DocFX-related configurations, scripts, and workflows.
- Consolidated API documentation in Docusaurus, removing dependency on generated C# API references.
- Updated `.gitignore` to exclude DocFX artifacts and cleaned up obsolete files.
- Adjusted `package.json` to streamline docs development workflow.
- Improved documentation structure and aesthetic consistency by refining styles and adding a favicon.
…vbar links, refine footer, and adjust primary color palette
@AnnaSasDev AnnaSasDev linked an issue Apr 10, 2026 that may be closed by this pull request
2 tasks
@AnnaSasDev AnnaSasDev merged commit d5b0c0c into core Apr 10, 2026
7 checks passed
@AnnaSasDev AnnaSasDev deleted the docusaurus branch April 10, 2026 14:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Feature | Move away from docfx to docusaurus

1 participant