Skip to content

Commit a3ed099

Browse files
committed
Updates and removal of chapter and appendix wording
1 parent a3550ee commit a3ed099

File tree

1 file changed

+97
-74
lines changed

1 file changed

+97
-74
lines changed

outline.md

Lines changed: 97 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,21 @@
11
# Outline for Pulsar documentation
22

3-
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.
3+
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.
44

55
## Old Already "Finished" sections
66

7-
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.
7+
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.
88

9-
### Chapter 1: Getting Started
9+
### Launch Manual
10+
11+
#### Getting Started
1012

1113
- Why Atom?
1214
- Installing Atom
1315
- Atom Basics
1416
- Summary
1517

16-
### Chapter 2: Using Atom
18+
#### Using Atom
1719

1820
- Atom Packages
1921
- Moving in Atom
@@ -32,7 +34,7 @@ These are alredy in our atom-archive folder. These just need to be reformatted,
3234
- Basic Customization
3335
- Summary
3436

35-
### Chapter 3: Hacking Atom
37+
#### Hacking Atom
3638

3739
- Tools of the Trade
3840
- The Init File
@@ -55,7 +57,7 @@ These are alredy in our atom-archive folder. These just need to be reformatted,
5557
- Maintaining a Fork of a Core Package in atom/atom
5658
- Summary
5759

58-
### Chapter 4: Behind Atom
60+
### Advanced topics
5961

6062
- Configuration API
6163
- Keymaps In-Depth
@@ -67,67 +69,13 @@ These are alredy in our atom-archive folder. These just need to be reformatted,
6769
- How Atom Uses Chromium Snapshots
6870
- Summary
6971

70-
### Reference: API
71-
72-
**_this section is not loaded in since it's in JSON files we need to parse._**
73-
74-
- AtomEnvironment
75-
- BufferedNodeProcess
76-
- BufferedProcess
77-
- Clipboard
78-
- Color
79-
- CommandRegistry
80-
- CompositeDisposable
81-
- Config
82-
- ContextMenuManager
83-
- Cursor
84-
- Decoration
85-
- DeserializerManager
86-
- Directory
87-
- DisplayMarker
88-
- DisplayMarkerLayer
89-
- Disposable
90-
- Dock
91-
- Emitter
92-
- File
93-
- GitRepository
94-
- Grammar
95-
- GrammarRegistry
96-
- Gutter
97-
- HistoryManager
98-
- KeymapManager
99-
- LayerDecoration
100-
- MarkerLayer
101-
- MenuManager
102-
- Notification
103-
- NotificationManager
104-
- Package
105-
- PackageManager
106-
- Pane
107-
- Panel
108-
- PathWatcher
109-
- Point
110-
- Project
111-
- Range
112-
- ScopeDescriptor
113-
- Selection
114-
- StyleManager
115-
- Task
116-
- TextBuffer
117-
- TextEditor
118-
- ThemeManager
119-
- TooltipManager
120-
- ViewRegistry
121-
- Workspace
122-
- WorkspaceCenter
123-
124-
### Appendix A: Resources
72+
### Resources
12573

12674
#### Glossary
12775

12876
- This section may be done already in the old one, but may need updating.
12977

130-
### Appendix B: FAQ
78+
### FAQ
13179

13280
- Is Atom open source?
13381
- What does Atom cost?
@@ -176,7 +124,7 @@ These are alredy in our atom-archive folder. These just need to be reformatted,
176124

177125
## The remaining bits to be written and finished:
178126

179-
### Chapter 3: Hacking Atom
127+
### Hacking Atom
180128

181129
- Tutorials:
182130
- Word Count Package (Basic)
@@ -203,7 +151,7 @@ These are alredy in our atom-archive folder. These just need to be reformatted,
203151
- Shadow DOM
204152
- https://atom.io/docs/latest/upgrading/upgrading-your-ui-theme
205153

206-
## Chapter 4: Behind Atom
154+
### Advanced Hacking
207155

208156
- advanced dev tools
209157
- keybinding resolver
@@ -218,8 +166,9 @@ These are alredy in our atom-archive folder. These just need to be reformatted,
218166
- view best practices
219167
- don't make a slow package
220168
- CI for packages (https://blog.atom.io/2014/04/25/ci-for-your-packages.html)
169+
- Reference Manual
221170

222-
### Include in Chapter 3 or 4
171+
### Include in Core Hacking or Behind Pulsar
223172

224173
- Make sure we include (in Ch 3 or Ch4 or both)
225174
- 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,
252201
- modal decorations
253202
- notifications
254203

255-
## Chapter 5: Contributing to Atom
204+
### Contributing to Atom
256205

257206
- To packages:
258207
- Cloning and apm linking
@@ -278,15 +227,89 @@ These are alredy in our atom-archive folder. These just need to be reformatted,
278227
- Coding conventions
279228
- Commit conventions
280229

281-
## ~Chapter 6: Electron~
230+
### Further
282231

283-
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.
232+
- Cookbook snippets <- this should be moved and put elsewhere.
233+
- As in this Is probably more tutorial related if we want to make a section based on tutorials and move them all there.
284234

285-
- ~developing a new project in electron~
286-
- ~https://github.com/atom/electron~
235+
### API Manual
287236

288-
## Chapter 7 / Appendix
237+
#### Client API
289238

290-
- Reference Manual
291-
- Cookbook snippets <- this should be moved and put elsewhere.
292-
- As in this Is probably more tutorial related if we want to make a section based on tutorials and move them all there.
239+
**_this section is not loaded in since it's in JSON files we need to parse._**
240+
241+
<!-- This section needs to be organized by purpose, if I'm looking for I/O, file management where would I go for that? I'm including some sections for this that we can decide upon which to add, and where to put what already exists -->
242+
243+
- File Management
244+
- I/O
245+
- Styling
246+
247+
<!-- These have not been categorized into any section above and need to be moved -->
248+
249+
- AtomEnvironment
250+
- BufferedNodeProcess
251+
- BufferedProcess
252+
- Clipboard
253+
- Color
254+
- CommandRegistry
255+
- CompositeDisposable
256+
- Config
257+
- ContextMenuManager
258+
- Cursor
259+
- Decoration
260+
- DeserializerManager
261+
- Directory
262+
- DisplayMarker
263+
- DisplayMarkerLayer
264+
- Disposable
265+
- Dock
266+
- Emitter
267+
- File
268+
- GitRepository
269+
- Grammar
270+
- GrammarRegistry
271+
- Gutter
272+
- HistoryManager
273+
- KeymapManager
274+
- LayerDecoration
275+
- MarkerLayer
276+
- MenuManager
277+
- Notification
278+
- NotificationManager
279+
- Package
280+
- PackageManager
281+
- Pane
282+
- Panel
283+
- PathWatcher
284+
- Point
285+
- Project
286+
- Range
287+
- ScopeDescriptor
288+
- Selection
289+
- StyleManager
290+
- Task
291+
- TextBuffer
292+
- TextEditor
293+
- ThemeManager
294+
- TooltipManager
295+
- ViewRegistry
296+
- Workspace
297+
- WorkspaceCenter
298+
299+
#### Package Server API
300+
301+
<!-- TODO -->
302+
303+
#### Other API
304+
305+
<!-- TODO This needs to figured out what others we need here -->
306+
307+
### Atom archive
308+
309+
The "chapters" from the orignal, this section is done. It only serves as a
310+
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
311+
leave them alone in this folder. However We do expect that you pull from here
312+
and update things if we do not already have it updated ourselves. It should be
313+
easier to pull from here instead of writing from scratch. If need be put
314+
warnings ala our common text blocks in the sections, warning that these are
315+
under active development to fit things.

0 commit comments

Comments
 (0)