Skip to content

Commit 5933947

Browse files
zcbenzzcbenz
committed
📝 Simpilify the structure of API references.
1 parent fae3cf9 commit 5933947

19 files changed

+25
-25
lines changed

‎docs/README.md‎

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Atom Shell Documentations
1+
# Atom Shell documents
22

33
## Tutorials
44

@@ -14,28 +14,28 @@
1414
* [Build instructions (Windows)](development/build-instructions-windows.md)
1515
* [Build instructions (Linux)](development/build-instructions-linux.md)
1616

17-
## API References
17+
## API references
1818

19-
Renderer side modules:
19+
Browser side modules:
2020

21-
* [ipc (renderer)](api/renderer/ipc-renderer.md)
22-
* [remote](api/renderer/remote.md)
21+
* [app](api/app.md)
22+
* [auto-updater](api/auto-updater.md)
23+
* [browser-window](api/browser-window.md)
24+
* [dialog](api/dialog.md)
25+
* [ipc (browser)](api/ipc-browser.md)
26+
* [menu](api/menu.md)
27+
* [menu-item](api/menu-item.md)
28+
* [power-monitor](api/power-monitor.md)
29+
* [protocol](api/protocol.md)
2330

24-
Browser side modules:
31+
Renderer side modules:
2532

26-
* [app](api/browser/app.md)
27-
* [auto-updater](api/browser/auto-updater.md)
28-
* [browser-window](api/browser/browser-window.md)
29-
* [dialog](api/browser/dialog.md)
30-
* [ipc (browser)](api/browser/ipc-browser.md)
31-
* [menu](api/browser/menu.md)
32-
* [menu-item](api/browser/menu-item.md)
33-
* [power-monitor](api/browser/power-monitor.md)
34-
* [protocol](api/browser/protocol.md)
33+
* [ipc (renderer)](api/ipc-renderer.md)
34+
* [remote](api/remote.md)
3535

3636
Common modules:
3737

38-
* [clipboard](api/common/clipboard.md)
39-
* [crash-reporter](api/common/crash-reporter.md)
40-
* [screen](api/common/screen.md)
41-
* [shell](api/common/shell.md)
38+
* [clipboard](api/clipboard.md)
39+
* [crash-reporter](api/crash-reporter.md)
40+
* [screen](api/screen.md)
41+
* [shell](api/shell.md)

docs/api/browser/app.md renamed to docs/api/app.md

File renamed without changes.

docs/api/browser/auto-updater.md renamed to docs/api/auto-updater.md

File renamed without changes.

docs/api/browser/browser-window.md renamed to docs/api/browser-window.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -346,7 +346,7 @@ You can write received `image` directly to a `.png` file, or you can base64
346346
encode it and use data URL to embed the image in HTML.
347347

348348
**Note:** Be sure to read documents on remote buffer in
349-
[remote](../renderer/remote.md) if you are going to use this API in renderer
349+
[remote](remote.md) if you are going to use this API in renderer
350350
process.
351351

352352
### BrowserWindow.loadUrl(url)

docs/api/common/clipboard.md renamed to docs/api/clipboard.md

File renamed without changes.

docs/api/common/crash-reporter.md renamed to docs/api/crash-reporter.md

File renamed without changes.

docs/api/browser/dialog.md renamed to docs/api/dialog.md

File renamed without changes.

docs/api/browser/frameless-window.md renamed to docs/api/frameless-window.md

File renamed without changes.

docs/api/browser/ipc-browser.md renamed to docs/api/ipc-browser.md

File renamed without changes.

docs/api/renderer/ipc-renderer.md renamed to docs/api/ipc-renderer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ asynchronous messages to the browser, and also receive messages sent from
55
browser. If you want to make use of modules of browser from renderer, you
66
might consider using the [remote](remote.md) module.
77

8-
See [ipc (browser)](../browser/ipc-browser.md) for examples.
8+
See [ipc (browser)](ipc-browser.md) for examples.
99

1010
## ipc.send(channel[, args...])
1111

0 commit comments

Comments
 (0)