Roadmap for the docs(based off flight manual)

[kaosine]

This is the original outline from the original flight manual. The first section is "finished" but needs to be moved. These are NOT to be touched other than changing the image refs to point to their new spot in our .github repo. As well as changing their danger, warning, info tags to ours. Then they can be copied into the appropriate section under the user_guide index file.

Chapters can be omitted during this part after moving them. We will probably need to reorganize and recategorize this section. However, keep note of the original placement upon moving it, so we can check off this list below. Some of these need to be sectioned down into a secondary header on the section.

The second part is the outline that the original team never finished. These will need to be written and added to our user_guide section. Do NOT add these to the archive section. We can not stress this enough, since the archive folder is simply that, an archive folder in a working condition

• Chapter 1: Getting Started #35
  • Why Pulsar? (the names will not match up, I'm changing them to match ours)
  • Installing Pulsar
  • Pulsar Basics
  • Summary
• Using pulsar refactoring from archive docs #38
  • Atom Packages
  • Moving in Pulsar
  • Pulsar Selections
  • Editing and Deleting Text
  • Find and Replace
  • Snippets
  • Autocomplete
  • Folding
  • Panes
  • Pending Pane Items
  • Grammar
  • Version Control in Pulsar
  • GitHub Package
  • Writing in Atom
  • Basic Customization
  • Summary
• Chapter 3: Hacking Pulsar
  • Tools of the Trade
  • The init file
  • Package: Word Count
  • Package: Modifying Text
  • Package: Active Editor Info
  • Creating a grammar
  • Creating a Legacy Textmate Grammar
  • Publishing
  • Iconography
  • Debugging
  • Handling URIs
  • Cross-platform Compatibilty
  • Converting from TextMate
  • Hacking on Pulsar Core
  • Contributing to Official Pulsar Packages
  • Creating a fork of a core packaging in pulsar-edit/pulsar
  • Maintaining a fork of a core package in pulsar-edit/pulsar
  • Summary

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?) (this should probably be one of the last we update as we wait for the LSP support that @mauricioszabo is working on)
  • 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 antipatterns)
  • 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
  • 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 Pulsar

• To packages
  • Cloning and ppm linking
  • ppm install/update
  • Native modules
  • Running specs
  • Link to sending a pull request
• To core
  • Opening issues
  • Roadmaps
    • (Need to place ours here, probably linking to the project tabs of our projects)
  • Where is the code?
  • Forum
  • Building Pulsar
  • Technologies it uses
    • Node
    • Atom-shell
    • ppm
    • npm
  • Coding conventions
  • Commit conventions

Chapter 6 / Appendix

• Reference Manual
• Cookbook snippets

Keep in note as mentioned above:

• With the "finished" section, only update the image refs and tags in the original location
  • if there is a tag similar to:

{{#warning}}
{{ /warning}}```

• It becomes:

::: warning
:::

• We also have the options to use any of the following: warning, danger, tip, and details.
• Then move to the user_guide index file. Recategorize this information as seen fit
• Unless it is urgent to have any part of the remaining sections, it is preferable to finish out the sections from the finished one, clearing up any details that are missing

[kaosine]

Parts removed because irrelevant, not something we maintain or have already archived ages ago (either by us or the original team)

• developing a new project in electron (electron isn't ours, and is managed by the electron organization)
• https://github.com/atom/electron
• Roadmaps(outdated and not used)
  • https://blog.atom.io/2014/10/23/public-roadmap.html
  • no longer spacepen (spacepen was archived ages ago and isn't a active thing for us

[confused-Techie]

Is this assuming then we keep Chapters 1 and 2 largely the same as they currently are?

[kaosine]

I'm assuming that's the parts they already finished. They just didn't get around to these parts as far as I can tell. Those are the ones we're going to have to move images to an asset's folder (and probably organize as atom specific). Then fix the image refs(that were already broken to begin with), and change their warning, danger and info tags to vuepress' version like I talked with you last night.

[kaosine]

I attached the relevant branch in the sidebar for reference, however. That's where I put them, since I knew good and well that it would break the site if they were directly in the main branch right now as is.

[confused-Techie]

@kaosine I see, thanks for the clarification. But sounds good then. We will see how we can implement these.

[kaosine]

I will recommend the following:

• We don't finish their docs (there's too many redactions and changes in workflow with atom and now pulsar it's going to be hard to finish it)
• Move the images in each folder to a seperate assets folder near the root, with a subfolder dedicated to their section of this (this should be covered in the vuepress docs how to handle assets)
• Fix the warning, danger and info tags and any other misc ones they may have had that causes breaks
• After that's all done and fixed, I'd move on to finishing out and tweaking this roadmap going forward. I know things have to of changed drastically since this was written since it hasn't been touched in 5 years.
• If we need confirmation of the structure(and I'm not sure why over time they deleted it instead of just checking it off) here's this: pulsar-edit/flight-manual.atom.io@9f223aa#diff-720e060489e24a21c44de5ada6d7bd54fb9d94698110368fcc5d4ab7b65161ac

I wouldn't much time on their end of things, and I'd go ahead and archive that repo I linked now in that last point. It is just a historical reference at this point and shouldn't be referenced seeing as we have it all migrated out content wise from what I can tell.

[kaosine]

Please don't remove my GFI tag, this is something that first-timers could help with. It doesn't take much exploration to see this stuff and know what to put, following the example we're about to put forth for this.

[kaosine]

Not sure if the linked posts from their blog are relevant and need to be backed up. Will have to check whenever I get a chance. Another part that probably needs a deep dive just to check things going forward, to make sure any info we need isn't missed somehow.

[kaosine]

Updated with the "finished" sections and changed the wording a bit. Guidelines that we agreed upon are in that first post. Check it for updates ^_^