Skip to content

Commit 0d97457

Browse files
committed
Fix typos and improve docs
1 parent aa34417 commit 0d97457

File tree

9 files changed

+30
-26
lines changed

9 files changed

+30
-26
lines changed

addons/aceeditor/addon-built.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

addons/aceeditor/client.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ define([
9999

100100
// Add files handler
101101
files.addHandler("ace", {
102-
name: "ACE Code Editor",
102+
name: "Code Editor",
103103
View: FileEditorView,
104104
valid: function(file) {
105105
return (!file.isDirectory() && _.contains(textExts, file.extension()));

client/core/files.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ define([
8282
_.each(handlers, function(handler) {
8383
choices[handler.id] = handler.name;
8484
});
85-
return dialogs.select("Can't open this file", "Sorry, No handler has been found to open this file. Try to find and install an addon to manage this file or select one of these handlers:", choices).then(function(value) {
85+
return dialogs.select("Can't open this file", "Sorry, No handler has been found to open this file. Try to find and install an add-on to manage this file or select one of the following handlers:", choices).then(function(value) {
8686
var handler = handlers[value];
8787
return Q(handler.open(file));
8888
});
@@ -112,7 +112,7 @@ define([
112112
_.each(possibleHandlers, function(handler) {
113113
choices[handler.id] = handler.name;
114114
})
115-
return dialogs.select("Open with...", "Select the handler to open this file", choices).then(function(value) {
115+
return dialogs.select("Open with...", "Select one of the following handlers to open this file:", choices).then(function(value) {
116116
var handler = handlers[value];
117117
return Q(handler.open(file));
118118
});

docs/README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,18 @@ This documentation contains everything you need to know for using Codebox or run
44

55
### Codebox IDE
66

7-
* [Keyboard shortcuts](shortcuts.md)
8-
* [Tabs](tabs.md)
7+
* [Keyboard shortcuts](client/shortcuts.md)
8+
* [Tabs](client/tabs.md)
9+
10+
---------------------------------------
11+
12+
### Add-on development
13+
14+
* [Publish add-ons](addons/publish.md)
915

1016
---------------------------------------
1117

1218
### Server side
1319

14-
* [Configuration with environment variables](env.md)
15-
* [Managing addons](addons.md)
20+
* [Configuration with environment variables](server/env.md)
21+
* [Managing addons](server/addons.md)

docs/addons/publish.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Publish an addon
2+
3+
You can publish an addon for the addon manager by using the command line tool: https://github.com/FriendCode/codebox-client
4+
5+
```
6+
$ codenow-io publish ./path/to/the/repository
7+
```
8+
9+
And also unpublish the addon:
10+
11+
```
12+
$ codenow-io unpublish ./path/to/the/repository
13+
```

docs/shortcuts.md renamed to docs/client/shortcuts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Keyboard Shortcuts
1+
# Keyboard Shortcuts
22

33
### Commands
44

docs/tabs.md renamed to docs/client/tabs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Tabs
1+
# Tabs
22

33
### Panels
44

docs/addons.md renamed to docs/server/addons.md

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,3 @@ WORKSPACE_ADDONS_DEFAULTS_DIR will be access in read-only mode but WORKSPACE_ADD
1212

1313
By default, Codebox will store the new addons into **.addons**.
1414
Caution: If the directory doesn't exists, Codebox will recursively create it.
15-
16-
17-
### Publish an addon
18-
19-
You can publish an addon for the addon manager by using the command line tool: https://github.com/FriendCode/codebox-client
20-
21-
```
22-
$ codenow-io publish ./path/to/the/repository
23-
```
24-
25-
And also unpublish the addon:
26-
27-
```
28-
$ codenow-io unpublish ./path/to/the/repository
29-
```

docs/env.md renamed to docs/server/env.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Environment variables
1+
# Environment variables
22

33
Codebox use environment variables for defining its conffiguration, here is a list of all possibles configurations:
44

0 commit comments

Comments
 (0)