⚛️ What is Electron?

Electron is a JavaScript framework that empowers developers to create cross-platform desktop applications using HTML, CSS, and JavaScript. Over the years, it has grown to be a leader in desktop app development, with over 100,000 stars on GitHub and a long list of companies that trust it to to build high-quality applications that users love, including Notion, Postman, WhatsApp, Microsoft Teams, Slack, and Visual Studio Code.

💡 Project Ideas

Although our documentation pages get hundreds of thousands of unique page views every month, we are very far away from having the structure and clarity of documentation we admire. The project list below outlines a couple ideas we have for Season of Docs 2024, but these are only a few examples of the many improvements we could make. A technical writer involved in any of these project ideas will work alongside Electron's Ecosystem Working Group to refine these initial idea drafts and implement them in the electronjs.org documentation.

For inquiries or to express interest in contributing, please reach out to [email protected].

1. Electron Forge: Revamping App Developer Guides

➡️ Scope

Electron Forge is Electron’s official recommended tool for packaging and distributing Electron applications. It combines many single-purpose packages and handles things like code signing, installers, and artifact publishing for application developers.

Forge does have a basic set of existing documentation: new developers can easily access tutorials for scaffolding their apps, and use the existing plugins to add specific functionality. However, it is unclear where new developers should go from there, as the complexity of Forge can be overwhelming to developers who are new to the framework.

Examples of things which could be structured better:

Addressing frequently asked questions, such as adding icons, file associations, or front-end framework integrations
Cross-referencing items between Electron Forge and Electron itself
Packaging and creating installers for cross-platform use
Examples of using Electron Forge with popular CI pipelines and publishing artifacts

Additionally, there are several Forge tutorials that exist in Electron’s docs: for example, packaging your application. It would be good to consolidate that knowledge into one location, instead of spread across multiple websites.

Most of the documentation for Electron Forge resides in a separate repository: electron-forge/electron-forge-docs

➡️ Project Deliverables

Better information architecture for Forge’s existing documentation