Skip to content

Conversation

softworkz
Copy link
Contributor

@softworkz softworkz commented Oct 15, 2025

I have manually reviewed and revised everything excepting the pages under "API Reference". I also have no intentions to do so - I mean, it's better than before (=nothing) and when somebody finds errors, they can submit a PR to fix it.

The current result can be viewed here: https://github.com/softworkz/ElectronNET/wiki

The included CI for updating the WIki pages is restricted to the branches main and electronnet_core (mine), so that it won't start overwriting the Wiki before it's in the main branch.

@Copilot Copilot AI review requested due to automatic review settings October 15, 2025 20:21
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds comprehensive documentation to the ElectronNET project, manually reviewed and revised with the exception of API Reference pages. The documentation is structured as a Wiki with automated publishing via GitHub Actions, restricted to main and electronnet_core branches.

Key Changes:

  • Complete documentation structure covering getting started, usage guides, API reference, and migration information
  • GitHub Actions workflow for automated Wiki publishing
  • Visual Studio solution organization for documentation files

Reviewed Changes

Copilot reviewed 39 out of 45 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
src/ElectronNET.sln Added documentation project structure and CI workflow references to solution
docs/_Sidebar.md Wiki navigation sidebar with complete documentation hierarchy
docs/_Footer.md Wiki footer with contribution information
docs/Home.md Main wiki landing page with overview and navigation
docs/About.md Project information, community links, and contributor details
docs/GettingStarted/*.md Setup guides for ASP.NET and console applications
docs/Using/*.md Configuration, debugging, startup methods, and package building guides
docs/Core/*.md Migration guides and what's new documentation
docs/API/*.md API reference documentation for Electron modules
docs/RelInfo/*.md Package descriptions and release information
docs/Docs.shproj Shared project file for documentation organization
docs/.docproj/* MSBuild configuration for documentation project
.github/workflows/publish-wiki.yml GitHub Actions workflow for automated Wiki publishing
README.md Updated links to point to Wiki documentation

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@softworkz softworkz mentioned this pull request Oct 15, 2025
Copy link
Collaborator

@FlorianRappl FlorianRappl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Superb - much appreciated!

@FlorianRappl FlorianRappl merged commit be1887c into ElectronNET:develop Oct 16, 2025
2 of 3 checks passed
@softworkz
Copy link
Contributor Author

softworkz commented Oct 16, 2025

Thanks. That's pretty much it, now.
I tried to get the maximum out from very little time, so there are surely some rough edges here and there at the side of documentation.
For the code, I think that it's all rather solid.
Have you had a chance to try it - any issues encountered?

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.

2 participants