[PR #895] [MERGED] Add documentation #1340

Open
opened 2026-01-29 16:59:45 +00:00 by claunia · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/ElectronNET/Electron.NET/pull/895
Author: @softworkz
Created: 10/15/2025
Status: Merged
Merged: 10/16/2025
Merged by: @FlorianRappl

Base: developHead: electronnet_core


📝 Commits (10+)

📊 Changes

46 files changed (+13368 additions, -59 deletions)

View changed files

.github/WikiLinks.exe (+0 -0)
.github/workflows/publish-wiki.yml (+59 -0)
📝 README.md (+6 -52)
docs/.docproj/DocProj.props (+27 -0)
docs/.docproj/DocProj.targets (+23 -0)
docs/API/App.md (+489 -0)
docs/API/AutoUpdater.md (+243 -0)
docs/API/Clipboard.md (+231 -0)
docs/API/Dialog.md (+160 -0)
docs/API/Dock.md (+209 -0)
docs/API/GlobalShortcut.md (+189 -0)
docs/API/HostHook.md (+152 -0)
docs/API/IpcMain.md (+167 -0)
docs/API/Menu.md (+210 -0)
docs/API/NativeTheme.md (+189 -0)
docs/API/Notification.md (+164 -0)
docs/API/Overview.md (+62 -0)
docs/API/PowerMonitor.md (+188 -0)
docs/API/Screen.md (+174 -0)
docs/API/Shell.md (+175 -0)

...and 26 more files

📄 Description

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.


🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/ElectronNET/Electron.NET/pull/895 **Author:** [@softworkz](https://github.com/softworkz) **Created:** 10/15/2025 **Status:** ✅ Merged **Merged:** 10/16/2025 **Merged by:** [@FlorianRappl](https://github.com/FlorianRappl) **Base:** `develop` ← **Head:** `electronnet_core` --- ### 📝 Commits (10+) - [`7b812bf`](https://github.com/ElectronNET/Electron.NET/commit/7b812bfae78312a415e2ba3eb9e27850f612ef6b) Remove whatsnew from root - [`0a0e26a`](https://github.com/ElectronNET/Electron.NET/commit/0a0e26a9ddfff774564a1d2279294d17cc59bc98) Add docs - [`0dd263e`](https://github.com/ElectronNET/Electron.NET/commit/0dd263e2b8492afc60f22485f15562c179e94993) Docs: add automatic Wiki publishing - [`bb5779a`](https://github.com/ElectronNET/Electron.NET/commit/bb5779a9415c13b025532ad5f7720c24fcac2a85) Add docs project to solution - [`0c5cc3b`](https://github.com/ElectronNET/Electron.NET/commit/0c5cc3ba9d01cf4448fa667b4751e93f783b30a8) AI-written docs - [`341ebe2`](https://github.com/ElectronNET/Electron.NET/commit/341ebe2bb158bc7ff3d9cdfd35411155bc4ed01b) Add .gitkeep file - [`88766ad`](https://github.com/ElectronNET/Electron.NET/commit/88766adaf6a8d9ef0b44b870135f79c396ac325a) Update docs after manual review - [`56258d1`](https://github.com/ElectronNET/Electron.NET/commit/56258d1be84fb4d702de9e99d1443bf67c3023f9) Add API documentation (AI generated) - [`771b110`](https://github.com/ElectronNET/Electron.NET/commit/771b1109f7083a4d1299646ee9fa5865e5ca52df) Add About page - [`2bc2b4b`](https://github.com/ElectronNET/Electron.NET/commit/2bc2b4bb7073cc713cf205fa8e104c746508c1e6) Move some parts from ReadMe to Wiki ### 📊 Changes **46 files changed** (+13368 additions, -59 deletions) <details> <summary>View changed files</summary> ➕ `.github/WikiLinks.exe` (+0 -0) ➕ `.github/workflows/publish-wiki.yml` (+59 -0) 📝 `README.md` (+6 -52) ➕ `docs/.docproj/DocProj.props` (+27 -0) ➕ `docs/.docproj/DocProj.targets` (+23 -0) ➕ `docs/API/App.md` (+489 -0) ➕ `docs/API/AutoUpdater.md` (+243 -0) ➕ `docs/API/Clipboard.md` (+231 -0) ➕ `docs/API/Dialog.md` (+160 -0) ➕ `docs/API/Dock.md` (+209 -0) ➕ `docs/API/GlobalShortcut.md` (+189 -0) ➕ `docs/API/HostHook.md` (+152 -0) ➕ `docs/API/IpcMain.md` (+167 -0) ➕ `docs/API/Menu.md` (+210 -0) ➕ `docs/API/NativeTheme.md` (+189 -0) ➕ `docs/API/Notification.md` (+164 -0) ➕ `docs/API/Overview.md` (+62 -0) ➕ `docs/API/PowerMonitor.md` (+188 -0) ➕ `docs/API/Screen.md` (+174 -0) ➕ `docs/API/Shell.md` (+175 -0) _...and 26 more files_ </details> ### 📄 Description 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. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
claunia added the pull-request label 2026-01-29 16:59:45 +00:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/Electron.NET#1340