From 09d080503145c6ac15a8a9474c12dd6ccbaace99 Mon Sep 17 00:00:00 2001 From: Josh <16845458+kaosine@users.noreply.github.com> Date: Sat, 1 Oct 2022 16:17:19 -0400 Subject: [PATCH 1/9] Initial Commit with a few tweaks. --- outline.md | 292 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 292 insertions(+) create mode 100644 outline.md diff --git a/outline.md b/outline.md new file mode 100644 index 000000000..361203b99 --- /dev/null +++ b/outline.md @@ -0,0 +1,292 @@ +# Outline for Pulsar documentation + +This uses the og atom Flight manual as a base, and converts and refactors it for modern standards. This will be converted to and tracked from our projects using seperate ones for each section. + +## Old Already "Finished" sections + +These are alredy in our atom-archive folder. These just need to be reformatted, branding changed, and use ours and more modern standards. Especially since as we move to more updated libraries methods mentioned in these sections will change and/or break. + +### Chapter 1: Getting Started + +- Why Atom? +- Installing Atom +- Atom Basics +- Summary + +### Chapter 2: Using Atom + +- Atom Packages +- Moving in Atom +- Atom Selections +- Editing and Deleting Text +- Find and Replace +- Snippets +- Autocomplete +- Folding +- Panes +- Pending Pane Items +- Grammar +- Version Control in Atom +- GitHub package +- Writing in Atom +- Basic Customization +- Summary + +### Chapter 3: Hacking Atom + +- Tools of the Trade +- The Init File +- Package: Word Count +- Package: Modifying Text +- Package: Active Editor Info +- Creating a Theme +- Creating a Grammar +- Creating a Legacy TextMate Grammar +- Publishing +- Iconography +- Debugging +- Writing specs +- Handling URIs +- Cross-Platform Compatibility +- Converting from TextMate +- Hacking on Atom Core +- Contributing to Official Atom Packages +- Creating a Fork of a Core Package in atom/atom +- Maintaining a Fork of a Core Package in atom/atom +- Summary + +### Chapter 4: Behind Atom + +- Configuration API +- Keymaps In-Depth +- Scoped Settings, Scopes and Scope Descriptors +- Serialization in Atom +- Developing Node Modules +- Interacting With Other Packages Via Services +- Maintaining Your Packages +- How Atom Uses Chromium Snapshots +- Summary + +### Reference: API + +**_ this section is not loaded in since it's in JSON files we need to parse. _** + +- AtomEnvironment +- BufferedNodeProcess +- BufferedProcess +- Clipboard +- Color +- CommandRegistry +- CompositeDisposable +- Config +- ContextMenuManager +- Cursor +- Decoration +- DeserializerManager +- Directory +- DisplayMarker +- DisplayMarkerLayer +- Disposable +- Dock +- Emitter +- File +- GitRepository +- Grammar +- GrammarRegistry +- Gutter +- HistoryManager +- KeymapManager +- LayerDecoration +- MarkerLayer +- MenuManager +- Notification +- NotificationManager +- Package +- PackageManager +- Pane +- Panel +- PathWatcher +- Point +- Project +- Range +- ScopeDescriptor +- Selection +- StyleManager +- Task +- TextBuffer +- TextEditor +- ThemeManager +- TooltipManager +- ViewRegistry +- Workspace +- WorkspaceCenter + +### Appendix A: Resources + +#### Glossary + +- This section may be done already in the old one, but may need updating. + +### Appendix B: FAQ + +- Is Atom open source? +- What does Atom cost? +- What platforms does Atom run on? +- How can I contribute to Atom? +- Why does Atom collect usage data? +- Atom in the cloud? +- What's the difference between an IDE and an editor? +- How can I tell if subpixel antialiasing is working? +- Why is Atom deleting trailing whitespace? Why is there a newline at the end of the file? +- What does Safe Mode do? +- I have a question about a specific Atom community package. Where is the best place to ask it? +- I’m using an international keyboard and keys that use AltGr or Ctrl+Alt aren’t working +- I’m having a problem with Julia! What do I do? +- I’m getting an error about a “self-signed certificate”. What do I do? +- I’m having a problem with PlatformIO! What do I do? +- How do I make Atom recognize a file with extension X as language Y? +- How do I make the Welcome screen stop showing up? +- How do I preview web page changes automatically? +- How do I accept input from my program or script when using the script package? +- I am unable to update to the latest version of Atom on macOS. How do I fix this? +- I’m trying to change my syntax colors from styles.less, but it isn’t working! +- How do I build or execute code I've written in Atom? +- How do I uninstall Atom on macOS? +- macOS Mojave font rendering change +- Why does macOS say that Atom wants to access my calendar, contacts, photos, etc.? +- How do I turn on line wrap? +- The menu bar disappeared, how do I get it back? +- How do I use a newline in the result of find and replace? +- What is this line on the right in the editor view? + +### Appendix C: Shadow DOM + +- Removing Shadow DOM styles + +### Appendix D: Upgrading to 1.0 APIs + +- Upgrading Your Package +- Upgrading Your UI Theme Or Package Selectors +- Upgrading Your Syntax Theme + +### Appendix E: Atom server-side APIs + +- Atom package server API +- Atom update server API + +## The remaining bits to be written and finished: + +### 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 + - between here and npm, probably list the packages we make suse of and what they do in terms of the project. This is going to be where we need support from the Core and backend team. + - Atom-shell + - apm + - npm + - Etch with note we're transitioning to solidjs + - Electron + - Coding conventions + - Commit conventions + +## ~Chapter 6: Electron~ + +This section is probably going to be relegated to not being implemented. We have no control over electron and the best we can do is point people to their website elsewhere. + +- ~developing a new project in electron~ +- ~https://github.com/atom/electron~ + +## Chapter 7 / Appendix + +- Reference Manual +- Cookbook snippets <- this should be moved and put elsewhere. + - As in this Is probably more tutorial related if we want to make a section based on tutorials and move them all there. From e9042017682cf5be0e91440ce15ec65c8354ce56 Mon Sep 17 00:00:00 2001 From: Joshua MIller <16845458+kaosine@users.noreply.github.com> Date: Sat, 1 Oct 2022 17:10:06 -0400 Subject: [PATCH 2/9] Update outline.md Co-authored-by: softcode <108250871+softcode589@users.noreply.github.com> --- outline.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/outline.md b/outline.md index 361203b99..f3005614a 100644 --- a/outline.md +++ b/outline.md @@ -69,7 +69,7 @@ These are alredy in our atom-archive folder. These just need to be reformatted, ### Reference: API -**_ this section is not loaded in since it's in JSON files we need to parse. _** +**_this section is not loaded in since it's in JSON files we need to parse._** - AtomEnvironment - BufferedNodeProcess From d8717e455a06e4ce5528b11b1ac660bedcb7bed9 Mon Sep 17 00:00:00 2001 From: Joshua MIller <16845458+kaosine@users.noreply.github.com> Date: Sat, 1 Oct 2022 17:10:15 -0400 Subject: [PATCH 3/9] Update outline.md Co-authored-by: softcode <108250871+softcode589@users.noreply.github.com> --- outline.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/outline.md b/outline.md index f3005614a..c432274fa 100644 --- a/outline.md +++ b/outline.md @@ -178,7 +178,7 @@ These are alredy in our atom-archive folder. These just need to be reformatted, ### Chapter 3: Hacking Atom -- Tutorials +- Tutorials: - Word Count Package (Basic) - Word Count Status Bar (status bar manipulation) - Go To Line Package (simple with feedback and cursor movement) From db619d65eeab361b4a8063fc77650accd18b8a20 Mon Sep 17 00:00:00 2001 From: Joshua MIller <16845458+kaosine@users.noreply.github.com> Date: Sat, 1 Oct 2022 17:11:23 -0400 Subject: [PATCH 4/9] Update outline.md Co-authored-by: softcode <108250871+softcode589@users.noreply.github.com> --- outline.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/outline.md b/outline.md index c432274fa..7f76f2820 100644 --- a/outline.md +++ b/outline.md @@ -254,7 +254,7 @@ These are alredy in our atom-archive folder. These just need to be reformatted, ## Chapter 5: Contributing to Atom -- To packages +- To packages: - Cloning and apm linking - apm install/update - Native modules From a3550ee4d2389d584c6155b6f34f5bb6dd445d59 Mon Sep 17 00:00:00 2001 From: Joshua MIller <16845458+kaosine@users.noreply.github.com> Date: Sat, 1 Oct 2022 17:11:30 -0400 Subject: [PATCH 5/9] Update outline.md Co-authored-by: softcode <108250871+softcode589@users.noreply.github.com> --- outline.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/outline.md b/outline.md index 7f76f2820..3ce591c4c 100644 --- a/outline.md +++ b/outline.md @@ -260,7 +260,7 @@ These are alredy in our atom-archive folder. These just need to be reformatted, - Native modules - Running specs - Link to sending a pull request -- To core +- To core: - Opening issues - Roadmaps - https://blog.atom.io/2014/10/23/public-roadmap.html From a3ed099aecffbd5ae9c1eaf4410ee5e9a92009e4 Mon Sep 17 00:00:00 2001 From: Josh <16845458+kaosine@users.noreply.github.com> Date: Sat, 1 Oct 2022 18:06:52 -0400 Subject: [PATCH 6/9] Updates and removal of chapter and appendix wording --- outline.md | 171 ++++++++++++++++++++++++++++++----------------------- 1 file changed, 97 insertions(+), 74 deletions(-) diff --git a/outline.md b/outline.md index 3ce591c4c..69be4fd62 100644 --- a/outline.md +++ b/outline.md @@ -1,19 +1,21 @@ # Outline for Pulsar documentation -This uses the og atom Flight manual as a base, and converts and refactors it for modern standards. This will be converted to and tracked from our projects using seperate ones for each section. +This uses the original material from the Atom Flight manual(their documentation) as a base, and converts and refactors it for modern standards. This will be converted to and tracked from our projects using seperate ones for each section. It is fully expected that all text from your sections has been ran through a tool like [Language Tool](https://languagetool.org). All material should be free from as many errors as possible. We would like to eventually add support for other languages using a language translation service. That way we aren't alienating our userbases from other parts of the world. ## Old Already "Finished" sections -These are alredy in our atom-archive folder. These just need to be reformatted, branding changed, and use ours and more modern standards. Especially since as we move to more updated libraries methods mentioned in these sections will change and/or break. +These are already in our atom-archive folder. These just need to be reformatted, branding changed, and use ours and more modern standards. Especially since as we move to more updated libraries methods mentioned in these sections will change and/or break. -### Chapter 1: Getting Started +### Launch Manual + +#### Getting Started - Why Atom? - Installing Atom - Atom Basics - Summary -### Chapter 2: Using Atom +#### Using Atom - Atom Packages - Moving in Atom @@ -32,7 +34,7 @@ These are alredy in our atom-archive folder. These just need to be reformatted, - Basic Customization - Summary -### Chapter 3: Hacking Atom +#### Hacking Atom - Tools of the Trade - The Init File @@ -55,7 +57,7 @@ These are alredy in our atom-archive folder. These just need to be reformatted, - Maintaining a Fork of a Core Package in atom/atom - Summary -### Chapter 4: Behind Atom +### Advanced topics - Configuration API - Keymaps In-Depth @@ -67,67 +69,13 @@ These are alredy in our atom-archive folder. These just need to be reformatted, - How Atom Uses Chromium Snapshots - Summary -### Reference: API - -**_this section is not loaded in since it's in JSON files we need to parse._** - -- AtomEnvironment -- BufferedNodeProcess -- BufferedProcess -- Clipboard -- Color -- CommandRegistry -- CompositeDisposable -- Config -- ContextMenuManager -- Cursor -- Decoration -- DeserializerManager -- Directory -- DisplayMarker -- DisplayMarkerLayer -- Disposable -- Dock -- Emitter -- File -- GitRepository -- Grammar -- GrammarRegistry -- Gutter -- HistoryManager -- KeymapManager -- LayerDecoration -- MarkerLayer -- MenuManager -- Notification -- NotificationManager -- Package -- PackageManager -- Pane -- Panel -- PathWatcher -- Point -- Project -- Range -- ScopeDescriptor -- Selection -- StyleManager -- Task -- TextBuffer -- TextEditor -- ThemeManager -- TooltipManager -- ViewRegistry -- Workspace -- WorkspaceCenter - -### Appendix A: Resources +### Resources #### Glossary - This section may be done already in the old one, but may need updating. -### Appendix B: FAQ +### FAQ - Is Atom open source? - What does Atom cost? @@ -176,7 +124,7 @@ These are alredy in our atom-archive folder. These just need to be reformatted, ## The remaining bits to be written and finished: -### Chapter 3: Hacking Atom +### Hacking Atom - Tutorials: - Word Count Package (Basic) @@ -203,7 +151,7 @@ These are alredy in our atom-archive folder. These just need to be reformatted, - Shadow DOM - https://atom.io/docs/latest/upgrading/upgrading-your-ui-theme -## Chapter 4: Behind Atom +### Advanced Hacking - advanced dev tools - keybinding resolver @@ -218,8 +166,9 @@ These are alredy in our atom-archive folder. These just need to be reformatted, - view best practices - don't make a slow package - CI for packages (https://blog.atom.io/2014/04/25/ci-for-your-packages.html) +- Reference Manual -### Include in Chapter 3 or 4 +### Include in Core Hacking or Behind Pulsar - Make sure we include (in Ch 3 or Ch4 or both) - scopes (https://atom.io/docs/v0.174.0/advanced/scopes-and-scope-descriptors) @@ -252,7 +201,7 @@ These are alredy in our atom-archive folder. These just need to be reformatted, - modal decorations - notifications -## Chapter 5: Contributing to Atom +### Contributing to Atom - To packages: - Cloning and apm linking @@ -278,15 +227,89 @@ These are alredy in our atom-archive folder. These just need to be reformatted, - Coding conventions - Commit conventions -## ~Chapter 6: Electron~ +### Further -This section is probably going to be relegated to not being implemented. We have no control over electron and the best we can do is point people to their website elsewhere. +- Cookbook snippets <- this should be moved and put elsewhere. + - As in this Is probably more tutorial related if we want to make a section based on tutorials and move them all there. -- ~developing a new project in electron~ -- ~https://github.com/atom/electron~ +### API Manual -## Chapter 7 / Appendix +#### Client API -- Reference Manual -- Cookbook snippets <- this should be moved and put elsewhere. - - As in this Is probably more tutorial related if we want to make a section based on tutorials and move them all there. +**_this section is not loaded in since it's in JSON files we need to parse._** + + + +- File Management +- I/O +- Styling + + + +- AtomEnvironment +- BufferedNodeProcess +- BufferedProcess +- Clipboard +- Color +- CommandRegistry +- CompositeDisposable +- Config +- ContextMenuManager +- Cursor +- Decoration +- DeserializerManager +- Directory +- DisplayMarker +- DisplayMarkerLayer +- Disposable +- Dock +- Emitter +- File +- GitRepository +- Grammar +- GrammarRegistry +- Gutter +- HistoryManager +- KeymapManager +- LayerDecoration +- MarkerLayer +- MenuManager +- Notification +- NotificationManager +- Package +- PackageManager +- Pane +- Panel +- PathWatcher +- Point +- Project +- Range +- ScopeDescriptor +- Selection +- StyleManager +- Task +- TextBuffer +- TextEditor +- ThemeManager +- TooltipManager +- ViewRegistry +- Workspace +- WorkspaceCenter + +#### Package Server API + + + +#### Other API + + + +### Atom archive + +The "chapters" from the orignal, this section is done. It only serves as a +reference guide to make copies of in it's new home and then `rebrand -> update -> reorganize` we fully expect that these files are now at a state where we can +leave them alone in this folder. However We do expect that you pull from here +and update things if we do not already have it updated ourselves. It should be +easier to pull from here instead of writing from scratch. If need be put +warnings ala our common text blocks in the sections, warning that these are +under active development to fit things. From 1d35b5979b15389e06873f96f9e0e16322316900 Mon Sep 17 00:00:00 2001 From: Josh <16845458+kaosine@users.noreply.github.com> Date: Sun, 2 Oct 2022 08:32:38 -0400 Subject: [PATCH 7/9] Update and remove spacepen --- outline.md | 71 +++++++++++++++++++++++++++--------------------------- 1 file changed, 35 insertions(+), 36 deletions(-) diff --git a/outline.md b/outline.md index 69be4fd62..7a43f2e57 100644 --- a/outline.md +++ b/outline.md @@ -10,16 +10,16 @@ These are already in our atom-archive folder. These just need to be reformatted, #### Getting Started -- Why Atom? -- Installing Atom -- Atom Basics +- Why Pulsar? +- Installing Pulsar +- Pulsar Basics - Summary -#### Using Atom +#### Using Pulsar -- Atom Packages -- Moving in Atom -- Atom Selections +- Pulsar Packages +- Moving in Pulsar +- Pulsar Selections - Editing and Deleting Text - Find and Replace - Snippets @@ -28,13 +28,13 @@ These are already in our atom-archive folder. These just need to be reformatted, - Panes - Pending Pane Items - Grammar -- Version Control in Atom +- Version Control in Pulsar - GitHub package -- Writing in Atom +- Writing in Pulsar - Basic Customization - Summary -#### Hacking Atom +#### Hacking Pulsar - Tools of the Trade - The Init File @@ -51,10 +51,10 @@ These are already in our atom-archive folder. These just need to be reformatted, - Handling URIs - Cross-Platform Compatibility - Converting from TextMate -- Hacking on Atom Core -- Contributing to Official Atom Packages -- Creating a Fork of a Core Package in atom/atom -- Maintaining a Fork of a Core Package in atom/atom +- Hacking on Pulsar Core +- Contributing to Official Pulsar Packages +- Creating a Fork of a Core Package in pulsar/pulsar +- Maintaining a Fork of a Core Package in pulsar/pulsar - Summary ### Advanced topics @@ -62,11 +62,11 @@ These are already in our atom-archive folder. These just need to be reformatted, - Configuration API - Keymaps In-Depth - Scoped Settings, Scopes and Scope Descriptors -- Serialization in Atom +- Serialization in Pulsar - Developing Node Modules - Interacting With Other Packages Via Services - Maintaining Your Packages -- How Atom Uses Chromium Snapshots +- How Pulsar Uses Chromium Snapshots - Summary ### Resources @@ -77,31 +77,31 @@ These are already in our atom-archive folder. These just need to be reformatted, ### FAQ -- Is Atom open source? -- What does Atom cost? -- What platforms does Atom run on? -- How can I contribute to Atom? -- Why does Atom collect usage data? -- Atom in the cloud? +- Is Pulsar open source? +- What does Pulsar cost? +- What platforms does Pulsar run on? +- How can I contribute to Pulsar? +- Why does Pulsar collect usage data? +- Pulsar in the cloud? - What's the difference between an IDE and an editor? - How can I tell if subpixel antialiasing is working? -- Why is Atom deleting trailing whitespace? Why is there a newline at the end of the file? +- Why is Pulsar deleting trailing whitespace? Why is there a newline at the end of the file? - What does Safe Mode do? -- I have a question about a specific Atom community package. Where is the best place to ask it? +- I have a question about a specific Pulsar community package. Where is the best place to ask it? - I’m using an international keyboard and keys that use AltGr or Ctrl+Alt aren’t working - I’m having a problem with Julia! What do I do? - I’m getting an error about a “self-signed certificate”. What do I do? - I’m having a problem with PlatformIO! What do I do? -- How do I make Atom recognize a file with extension X as language Y? +- How do I make Pulsar recognize a file with extension X as language Y? - How do I make the Welcome screen stop showing up? - How do I preview web page changes automatically? - How do I accept input from my program or script when using the script package? -- I am unable to update to the latest version of Atom on macOS. How do I fix this? +- I am unable to update to the latest version of Pulsar on macOS. How do I fix this? - I’m trying to change my syntax colors from styles.less, but it isn’t working! -- How do I build or execute code I've written in Atom? -- How do I uninstall Atom on macOS? +- How do I build or execute code I've written in Pulsar? +- How do I uninstall Pulsar on macOS? - macOS Mojave font rendering change -- Why does macOS say that Atom wants to access my calendar, contacts, photos, etc.? +- Why does macOS say that Pulsar wants to access my calendar, contacts, photos, etc.? - How do I turn on line wrap? - The menu bar disappeared, how do I get it back? - How do I use a newline in the result of find and replace? @@ -117,14 +117,14 @@ These are already in our atom-archive folder. These just need to be reformatted, - Upgrading Your UI Theme Or Package Selectors - Upgrading Your Syntax Theme -### Appendix E: Atom server-side APIs +### Appendix E: Pulsar server-side APIs -- Atom package server API -- Atom update server API +- Pulsar package server API +- Pulsar update server API ## The remaining bits to be written and finished: -### Hacking Atom +### Hacking Pulsar - Tutorials: - Word Count Package (Basic) @@ -158,14 +158,14 @@ These are already in our atom-archive folder. These just need to be reformatted, - timecop - Maintaining Packages - how to publish - - Atom.io package system (adding, searching, stars) + - pulsar-edit.dev 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) + - CI for packages (https://blog.pulsar-edit.dev/2014/04/25/ci-for-your-packages.html) - Reference Manual ### Include in Core Hacking or Behind Pulsar @@ -184,7 +184,6 @@ These are already in our atom-archive folder. These just need to be reformatted, - subscribing to events - subscribing to commands - creating dom elements - - no longer spacepen - runners - configure my package - add application menu/context menu From a49711b99c939cd93f800672ffb1fec705dd29eb Mon Sep 17 00:00:00 2001 From: Josh <16845458+kaosine@users.noreply.github.com> Date: Sun, 2 Oct 2022 09:00:27 -0400 Subject: [PATCH 8/9] Update organization a bit --- outline.md | 44 +++++++++++++++++++++----------------------- 1 file changed, 21 insertions(+), 23 deletions(-) diff --git a/outline.md b/outline.md index 7a43f2e57..099a5a161 100644 --- a/outline.md +++ b/outline.md @@ -13,7 +13,6 @@ These are already in our atom-archive folder. These just need to be reformatted, - Why Pulsar? - Installing Pulsar - Pulsar Basics -- Summary #### Using Pulsar @@ -32,7 +31,6 @@ These are already in our atom-archive folder. These just need to be reformatted, - GitHub package - Writing in Pulsar - Basic Customization -- Summary #### Hacking Pulsar @@ -43,31 +41,38 @@ These are already in our atom-archive folder. These just need to be reformatted, - Package: Active Editor Info - Creating a Theme - Creating a Grammar -- Creating a Legacy TextMate Grammar +- Converting from TextMate + - Creating a Legacy TextMate Grammar +- Word Count Package (Basic) - Publishing - Iconography -- Debugging - Writing specs - Handling URIs - Cross-Platform Compatibility -- Converting from TextMate - Hacking on Pulsar Core - Contributing to Official Pulsar Packages -- Creating a Fork of a Core Package in pulsar/pulsar -- Maintaining a Fork of a Core Package in pulsar/pulsar -- Summary + - Creating a Fork of a Core Package in pulsar/pulsar + - Maintaining a Fork of a Core Package in pulsar/pulsar ### Advanced topics - Configuration API - Keymaps In-Depth - Scoped Settings, Scopes and Scope Descriptors + - scopes (https://atom.io/docs/v0.174.0/advanced/scopes-and-scope-descriptors) - Serialization in Pulsar - Developing Node Modules - Interacting With Other Packages Via Services - Maintaining Your Packages - How Pulsar Uses Chromium Snapshots -- Summary +- 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 ### Resources @@ -79,6 +84,7 @@ These are already in our atom-archive folder. These just need to be reformatted, - Is Pulsar open source? - What does Pulsar cost? +- Debugging - What platforms does Pulsar run on? - How can I contribute to Pulsar? - Why does Pulsar collect usage data? @@ -107,17 +113,19 @@ These are already in our atom-archive folder. These just need to be reformatted, - How do I use a newline in the result of find and replace? - What is this line on the right in the editor view? -### Appendix C: Shadow DOM +#### Shadow DOM - Removing Shadow DOM styles -### Appendix D: Upgrading to 1.0 APIs +#### Upgrading to 1.0 APIs - Upgrading Your Package - Upgrading Your UI Theme Or Package Selectors - Upgrading Your Syntax Theme -### Appendix E: Pulsar server-side APIs +### Api Manual + +#### Pulsar server-side APIs - Pulsar package server API - Pulsar update server API @@ -127,7 +135,6 @@ These are already in our atom-archive folder. These just need to be reformatted, ### Hacking Pulsar - 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) @@ -142,7 +149,7 @@ These are already in our atom-archive folder. These just need to be reformatted, - Autocomplete / Color picker (in-context UI) - Vim-mode (editor remapping) - Image View (file type rendering handler) - - Language (GFM?) + - Language - Creating grammars - converting-a-text-mate-bundle.md - Unity UI (UI theme) @@ -171,18 +178,9 @@ These are already in our atom-archive folder. These just need to be reformatted, ### Include in Core Hacking or Behind Pulsar - 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 From 3df7c7e0aafcbc572ea89aaf4cade1a52a225e1a Mon Sep 17 00:00:00 2001 From: Josh <16845458+kaosine@users.noreply.github.com> Date: Sun, 2 Oct 2022 09:18:10 -0400 Subject: [PATCH 9/9] Missed chapter replacement --- outline.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/outline.md b/outline.md index 099a5a161..37d8311b3 100644 --- a/outline.md +++ b/outline.md @@ -177,7 +177,7 @@ These are already in our atom-archive folder. These just need to be reformatted, ### Include in Core Hacking or Behind Pulsar -- Make sure we include (in Ch 3 or Ch4 or both) +- Make sure we include (in Core Hacking, Behind Pulsar or both) - views / models - settings (how to enable the settings button on the package installer) - notifications package