From 92241b91cedb002edc68c2218f9b5bfa0635c490 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 9 Sep 2013 15:49:13 +0800 Subject: [PATCH] doc: Separate pages into sub directories. --- docs/README.md | 38 +++++++++---------- docs/{ => api/browser}/app.md | 0 docs/{ => api/browser}/atom-delegate.md | 0 docs/{ => api/browser}/auto-updater.md | 0 docs/{ => api/browser}/browser-window.md | 0 docs/{ => api/browser}/crash-reporter.md | 0 docs/{ => api/browser}/dialog.md | 0 docs/{ => api/browser}/frameless-window.md | 2 +- docs/{ => api/browser}/ipc-browser.md | 0 docs/{ => api/browser}/menu-item.md | 0 docs/{ => api/browser}/menu.md | 0 docs/{ => api/browser}/power-monitor.md | 0 docs/{ => api/browser}/protocol.md | 0 docs/{ => api/common}/clipboard.md | 0 docs/{ => api/common}/shell.md | 0 docs/{ => api/renderer}/ipc-renderer.md | 0 docs/{ => api/renderer}/remote.md | 0 .../build-instructions-mac.md | 0 .../build-instructions-windows.md | 0 docs/{ => development}/coding-style.md | 0 .../source-code-directory-structure.md | 0 21 files changed, 20 insertions(+), 20 deletions(-) rename docs/{ => api/browser}/app.md (100%) rename docs/{ => api/browser}/atom-delegate.md (100%) rename docs/{ => api/browser}/auto-updater.md (100%) rename docs/{ => api/browser}/browser-window.md (100%) rename docs/{ => api/browser}/crash-reporter.md (100%) rename docs/{ => api/browser}/dialog.md (100%) rename docs/{ => api/browser}/frameless-window.md (96%) rename docs/{ => api/browser}/ipc-browser.md (100%) rename docs/{ => api/browser}/menu-item.md (100%) rename docs/{ => api/browser}/menu.md (100%) rename docs/{ => api/browser}/power-monitor.md (100%) rename docs/{ => api/browser}/protocol.md (100%) rename docs/{ => api/common}/clipboard.md (100%) rename docs/{ => api/common}/shell.md (100%) rename docs/{ => api/renderer}/ipc-renderer.md (100%) rename docs/{ => api/renderer}/remote.md (100%) rename docs/{ => development}/build-instructions-mac.md (100%) rename docs/{ => development}/build-instructions-windows.md (100%) rename docs/{ => development}/coding-style.md (100%) rename docs/{ => development}/source-code-directory-structure.md (100%) diff --git a/docs/README.md b/docs/README.md index 8d9ade34168b..b10054f88ca5 100644 --- a/docs/README.md +++ b/docs/README.md @@ -7,33 +7,33 @@ ## Development -* [Coding style](coding-style.md) -* [Source code directory structure](source-code-directory-structure.md) -* [Build instructions (Mac)](build-instructions-mac.md) -* [Build instructions (Windows)](build-instructions-windows.md) +* [Coding style](development/coding-style.md) +* [Source code directory structure](development/source-code-directory-structure.md) +* [Build instructions (Mac)](development/build-instructions-mac.md) +* [Build instructions (Windows)](development/build-instructions-windows.md) ## API References Renderer side modules: -* [ipc (renderer)](ipc-renderer.md) -* [remote](remote.md) +* [ipc (renderer)](api/renderer/ipc-renderer.md) +* [remote](api/renderer/remote.md) Browser side modules: -* [app](app.md) -* [atom-delegate](atom-delegate.md) -* [auto-updater](auto-updater.md) -* [browser-window](browser-window.md) -* [crash-reporter](crash-reporter.md) -* [dialog](dialog.md) -* [ipc (browser)](ipc-browser.md) -* [menu](menu.md) -* [menu-item](menu-item.md) -* [power-monitor](power-monitor.md) -* [protocol](protocol.md) +* [app](api/browser/app.md) +* [atom-delegate](api/browser/atom-delegate.md) +* [auto-updater](api/browser/auto-updater.md) +* [browser-window](api/browser/browser-window.md) +* [crash-reporter](api/browser/crash-reporter.md) +* [dialog](api/browser/dialog.md) +* [ipc (browser)](api/browser/ipc-browser.md) +* [menu](api/browser/menu.md) +* [menu-item](api/browser/menu-item.md) +* [power-monitor](api/browser/power-monitor.md) +* [protocol](api/browser/protocol.md) Common modules: -* [clipboard](clipboard.md) -* [shell](shell.md) +* [clipboard](api/common/clipboard.md) +* [shell](api/common/shell.md) diff --git a/docs/app.md b/docs/api/browser/app.md similarity index 100% rename from docs/app.md rename to docs/api/browser/app.md diff --git a/docs/atom-delegate.md b/docs/api/browser/atom-delegate.md similarity index 100% rename from docs/atom-delegate.md rename to docs/api/browser/atom-delegate.md diff --git a/docs/auto-updater.md b/docs/api/browser/auto-updater.md similarity index 100% rename from docs/auto-updater.md rename to docs/api/browser/auto-updater.md diff --git a/docs/browser-window.md b/docs/api/browser/browser-window.md similarity index 100% rename from docs/browser-window.md rename to docs/api/browser/browser-window.md diff --git a/docs/crash-reporter.md b/docs/api/browser/crash-reporter.md similarity index 100% rename from docs/crash-reporter.md rename to docs/api/browser/crash-reporter.md diff --git a/docs/dialog.md b/docs/api/browser/dialog.md similarity index 100% rename from docs/dialog.md rename to docs/api/browser/dialog.md diff --git a/docs/frameless-window.md b/docs/api/browser/frameless-window.md similarity index 96% rename from docs/frameless-window.md rename to docs/api/browser/frameless-window.md index b7ff5ca43054..881eb911f45c 100644 --- a/docs/frameless-window.md +++ b/docs/api/browser/frameless-window.md @@ -5,7 +5,7 @@ A frameless window is a window that has no chrome. ## Create a frameless window To create a frameless window, you only need to specify `frame` to `false` in -[BrowserWindow](browser-window.md)'s `options`: +[BrowserWindow](api/browser/browser-window.md)'s `options`: ```javascript diff --git a/docs/ipc-browser.md b/docs/api/browser/ipc-browser.md similarity index 100% rename from docs/ipc-browser.md rename to docs/api/browser/ipc-browser.md diff --git a/docs/menu-item.md b/docs/api/browser/menu-item.md similarity index 100% rename from docs/menu-item.md rename to docs/api/browser/menu-item.md diff --git a/docs/menu.md b/docs/api/browser/menu.md similarity index 100% rename from docs/menu.md rename to docs/api/browser/menu.md diff --git a/docs/power-monitor.md b/docs/api/browser/power-monitor.md similarity index 100% rename from docs/power-monitor.md rename to docs/api/browser/power-monitor.md diff --git a/docs/protocol.md b/docs/api/browser/protocol.md similarity index 100% rename from docs/protocol.md rename to docs/api/browser/protocol.md diff --git a/docs/clipboard.md b/docs/api/common/clipboard.md similarity index 100% rename from docs/clipboard.md rename to docs/api/common/clipboard.md diff --git a/docs/shell.md b/docs/api/common/shell.md similarity index 100% rename from docs/shell.md rename to docs/api/common/shell.md diff --git a/docs/ipc-renderer.md b/docs/api/renderer/ipc-renderer.md similarity index 100% rename from docs/ipc-renderer.md rename to docs/api/renderer/ipc-renderer.md diff --git a/docs/remote.md b/docs/api/renderer/remote.md similarity index 100% rename from docs/remote.md rename to docs/api/renderer/remote.md diff --git a/docs/build-instructions-mac.md b/docs/development/build-instructions-mac.md similarity index 100% rename from docs/build-instructions-mac.md rename to docs/development/build-instructions-mac.md diff --git a/docs/build-instructions-windows.md b/docs/development/build-instructions-windows.md similarity index 100% rename from docs/build-instructions-windows.md rename to docs/development/build-instructions-windows.md diff --git a/docs/coding-style.md b/docs/development/coding-style.md similarity index 100% rename from docs/coding-style.md rename to docs/development/coding-style.md diff --git a/docs/source-code-directory-structure.md b/docs/development/source-code-directory-structure.md similarity index 100% rename from docs/source-code-directory-structure.md rename to docs/development/source-code-directory-structure.md