#Electron api docs how to#
#Electron api docs code#
#Electron api docs download#

Week 5 - Prepare a template of how electron-api-demos will be integrated into the main documentation Week 4 - Restructure the documentation directory Create a summary page with a list of features that can be added to the app Week 3 - Revise Application Architecture, Adding Features to Your App, App Packaging and distribution pages. Week 2 - Revise Developer Environment and Writing Your First Electron App pages Week 1 - Align with mentors on the project milestones and deliverables Inspect the current state of Electron documentation. Make the first contributions.Ĭommunity Bonding - Explore the community. Learn community contribution guides and best practices. TIMELINEĪpplication Review Period - Get familiar with the community and people to work with.

#Electron api docs code#

The integration includes writing code samples for the updated tutorials and adding the “Launch in Fiddle” button to code blocks. This step will make it easier for new developers to see how a particular piece of code works without having to repeat the steps manually. Integrate Electron Fiddle examples into the documentation.

This information should be included in the Adding Features to Your App guide to be consistent with a single source of truth content strategy.ĥ.

#Electron api docs how to#

The electron-api-demos repository contains a set of examples that show how to add features to your Electron application. Include electron-api-demos repository in the documentation. All the features should have a unified set of instructions on how to install/enable it, how to get started quickly, how to work with an app after the first launch, and how to distribute it.Ĥ. Organize and unify application development documentation. Restructuring also includes guidance on the possible next steps.ģ. To show new developers of what is essential to getting started and what can be considered as further steps, the docs page should have both visual and contextual division of the steps to make the first application live as fast as possible. Adding Features to Your App (create a summary page)Ģ. To make the first steps smooth and consistent, the following documents should be updated with a gradual switch from simple to more complex: Disorganized pieces of “getting started” guide instructions with no single source of truth PROJECT PROPOSALĪccording to the project’s goal, and the issues outlined above, the following is a list of the proposed enhancements:ġ. Scattered and redundant information related to application development processģ. Unclear starting point and non-intuitive introduction information about application development stepsĢ. The following is a list of the most crucial issues related to Electron tutorials documentation:ġ. The project’s goal is to bring confidence to application builders who are new to the Electron framework and provide them with a consistent and streamlined experience in developing their own Electron applications from the ground-ups. Huge overall growth rates dictate the need for creating tutorials and getting started guides that are easy to grasp and use.

The popularity of Electron lies in its simple learning curve and low entry threshold - everyone who knows JavaScript, HTML, CSS stack can build their own application. Some of the most popular developer tools like Visual Studio Code, Atom, Postman, Slack, GitKraken are built on Electron. A collection of apps built on Electron has almost 900 entries and this list grows continuously.

Project summary Open source organization: Electron Technical writer: Mister Gold Project name: Electron Tutorial Flow Project length: Standard length (3 months) Project description PROJECT SUMMARYĮlectron is one of the most popular tools to build cross-platform desktop apps with JavaScript, HTML, and CSS. the supporting platforms (only if specific).This page contains the details of a technical writing project accepted for The haxe externs are attributed with following metadata: Spin up the included demo application to see electron in action: # Clone this repository

# Build haxedoc.xml to insure everything is fineīy default hxelectron/electron-api.json is used if you ommit the path argument to your custom description file. Haxe -macro ElectronAPI.generate('optional/path/to/electron-api.json')

#Electron api docs download#

To (re)generate for another electron version download the description file from and run: # Generate type definitions Haxelib git electron Generate Type DefinitionsĪll type definitions are generated from electron-api.json by ElectronAPI.hx. Haxe type definitions for electron, a framework for building cross-platform desktop applications with JavaScript, HTML, and CSS.