outline.md

This is the sort of planning document and outline for the Atom book. This largely outlines how we're composing the book and what is still to be done. We'll remove lines from this when each section is completed so we only have what it left to do here.

You'll notice in some of the active book/[section]/sections/ folders there are some xx-name.asciidoc files. These are sections of content that should probably be folded in at some point but we're not sure exactly where to put them. They aren't included in any of the main files, so they aren't currently rendered. If you want to write something and aren't sure where it goes, you can name the file in this manner until we figure out how to fold it into the narrative structure.

Here is the remaining outline:

Chapter 3: Hacking Atom

• Tutorials
  • Word Count Package (Basic)
  • Word Count Status Bar (status bar manipulation)
  • Go To Line Package (simple with feedback and cursor movement)
  • Open On GitHub - (no UI, just run command)
  • Snippets - (modify text in a buffer)
  • Linter - (modify text in a buffer, shell to external command)
  • Preview Pane (add a panel)
  • Fuzzy Finder (modal and open file in new tab)
  • Tree View / Mini-map (add a sidebar panel)
  • Status Bar (add small panel)
  • Git-Log / Settings View (standalone UI in tab)
  • Git-status / Bookmarks (decorate gutter)
  • Autocomplete / Color picker (in-context UI)
  • Vim-mode (editor remapping)
  • Image View (file type rendering handler)
  • Language (GFM?)
    • Creating grammars
    • converting-a-text-mate-bundle.md
  • Unity UI (UI theme)
    • converting-a-text-mate-theme.md
    • theme-variables.md
    • Shadow DOM
    • https://atom.io/docs/latest/upgrading/upgrading-your-ui-theme

Chapter 4: Behind Atom

• advanced dev tools
  • keybinding resolver
  • timecop
• Maintaining Packages
  • how to publish
    • Atom.io package system (adding, searching, stars)
  • changelog
  • issue tracker
• Best practices (patterns and anti-patterns)
  • aggregating subscriptions
  • view best practices
  • don't make a slow package
  • CI for packages (https://blog.atom.io/2014/04/25/ci-for-your-packages.html)

Include in Chapter 3 or 4

• Make sure we include (in Ch 3 or Ch4 or both)
  • scopes (https://atom.io/docs/v0.174.0/advanced/scopes-and-scope-descriptors)
  • views / models
  • settings (how to enable the settings button on the package installer)
  • notifications package
  • config api
    • https://blog.atom.io/2014/10/02/config-api-has-schema.html
    • https://blog.atom.io/2014/10/31/language-scoped-config.html
    • https://atom.io/docs/latest/advanced/scopes-and-scope-descriptors
  • subscriptions
    • https://blog.atom.io/2014/09/16/new-event-subscription-api.html
    • subscribing to events
    • subscribing to commands
  • creating dom elements
    • no longer spacepen
  • runners
  • configure my package
  • add application menu/context menu
  • get all the editors
  • understand when the active editor changes
  • background tasks
  • messages to the user
  • dialogs
  • advanced keymaps (in Guides)
  • serialization
  • converting textmate bundles
  • decoration (https://blog.atom.io/2014/07/24/decorations.html)
  • modal panel
  • modal decorations
  • notifications

Chapter 5: Contributing to Atom

• To packages
  • Cloning and apm linking
  • apm install/update
  • Native modules
  • Running specs
  • Link to sending a pull request
• To core
  • Opening issues
  • Roadmaps
    • https://blog.atom.io/2014/10/23/public-roadmap.html
  • Where is the code?
  • Forum
  • Building Atom
  • Technologies it uses
    • Node
    • Atom-shell
    • apm
    • npm
  • Coding conventions
  • Commit conventions

Chapter 6: Electron

• developing a new project in electron
• https://github.com/atom/electron

Chapter 7 / Appendix

• Reference Manual
• Cookbook snippets