GitBook: [#9] Expanded API documentation outliine.

jasonplatts · gitbook-bot · commit 71b492631b1d · 2022-04-17T17:51:50.000Z
diff --git a/README.md b/README.md
@@ -7,14 +7,14 @@ coverY: 150.05223251895535
 layout: landing
 ---
 
-# CodeEdit Extension API
+# Introduction
 
 ## Overview
 
 CodeEdit supports core languages and markup out-of-the-box, including HTML, JavaScript, and Markdown. Its user interface was designed to give developers a familiar and consistent Mac-like experience.
 
 Understandably, most developers will need support for other languages, require additional features, and have unique preferences. To meet these needs CodeEdit provides a robust JavaScript and React extension API.
 
-If you are new to extension development or would like to become familiar with the basics of creating and publishing extensions for CodeEdit, we highly recommend reading our [Getting Started](getting-started.md) page. To learn more about building different specific types of extensions, see the [Guides](broken-reference) section. For those wanting to jump right in and browse the exposed functionality, visit the [API](broken-reference) section. &#x20;
+If you are new to extension development or would like to become familiar with the basics of creating and publishing extensions for CodeEdit, we highly recommend reading our [Getting Started](getting-started/creating-an-extension.md) page. To learn more about building different specific types of extensions, see the [Guides](broken-reference) section. For those wanting to jump right in and browse the exposed functionality, visit the [API](broken-reference) section. &#x20;
 
 If you run into problems along the way, please reach out to our dedicated extension community on [Discord](https://discord.gg/vChUXVf9Em).
diff --git a/SUMMARY.md b/SUMMARY.md
@@ -1,12 +1,25 @@
 # Table of contents
 
-* [CodeEdit Extension API](README.md)
-* [Getting Started](getting-started.md)
+* [Introduction](README.md)
+
+## Getting Started
+
+* [Creating an Extension](getting-started/creating-an-extension.md)
+* [Developing an Extension](getting-started/developing-an-extension.md)
+* [Publishing an Extension](getting-started/publishing-an-extension.md)
+* [Debugging an Extension](getting-started/debugging-an-extension.md)
 
 ## Guides
 
-* [Page 1](guides/page-1.md)
+* [Building a Language Extension](guides/building-a-language-extension.md)
+* [Building a Treeview Extension](guides/building-a-treeview-extension.md)
+
+## API Reference
+
+* [API Structure](api-reference/api-structure.md)
+* [Editor](api-reference/editor.md)
+* [Completion Provider](api-reference/completion-provider.md)
 
-## API
+***
 
-* [Page 2](api/page-2.md)
+* [FAQ](faq.md)
diff --git a/api-reference/api-structure.md b/api-reference/api-structure.md
diff --git a/api-reference/completion-provider.md b/api-reference/completion-provider.md
@@ -0,0 +1,2 @@
+# Completion Provider
+
diff --git a/api-reference/editor.md b/api-reference/editor.md
@@ -0,0 +1,2 @@
+# Editor
+
diff --git a/faq.md b/faq.md
@@ -0,0 +1,2 @@
+# FAQ
+
diff --git a/getting-started.md b/getting-started.md
diff --git a/getting-started/creating-an-extension.md b/getting-started/creating-an-extension.md
@@ -0,0 +1,22 @@
+---
+description: Create a new extension project and become familiar with its file structure.
+---
+
+# Creating an Extension
+
+## System Requirements
+
+## Starting a New Extension
+
+## File and Folder Structure
+
+```
+.
+├── .gitignore
+├── README.md
+├── src/
+│   └── main.js
+└── manifest.json
+```
+
+## Manifest File
diff --git a/getting-started/debugging-an-extension.md b/getting-started/debugging-an-extension.md
@@ -0,0 +1,2 @@
+# Debugging an Extension
+
diff --git a/getting-started/developing-an-extension.md b/getting-started/developing-an-extension.md
@@ -0,0 +1,2 @@
+# Developing an Extension
+
diff --git a/getting-started/publishing-an-extension.md b/getting-started/publishing-an-extension.md
@@ -0,0 +1,2 @@
+# Publishing an Extension
+
diff --git a/guides/building-a-language-extension.md b/guides/building-a-language-extension.md
diff --git a/guides/building-a-treeview-extension.md b/guides/building-a-treeview-extension.md
@@ -0,0 +1,2 @@
+# Building a Treeview Extension
+

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+# Building a Treeview Extension`
	`2`	`+`